Retrieve details of a specific replication policy

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves details of a specific replication policy including transfer rates, schedule, and association count.

Request URL

https://{server-hostname}:8383/dcapi/som/replication-policies/{replication_policy_id}

Scope

SOM.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/replicationPolicyDetails.v1+jsonapplication/replicationPolicyDetails.v1+jsonCopied!

- Path Parameters

replication_policy_idstringMandatory

Unique identifier of the replication policy, get replication policy id from the Replication Policies api response(replicationPolicyID)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/som/replication-policies/{replication_policy_id} \
  --header 'Accept: application/replicationPolicyDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
replicationPolicyIDlong

Unique identifier of the replication policy

policyNamestring

Name of the replication policy defined by the administrator

descriptionstring

Description of the replication policy provided by the administrator. Returns an empty value if not specified

dataTransferRatestring

Maximum data transfer rate between endpoint central server and remote office (for example, 0 indicates no limit; supported values include 512, 1024, 2048)

dataTransferRateLANstring

Maximum Data transfer rate between remote offices and computers

replicationIntervalstring

Interval, in minutes, at which data is synchronized between the Distribution Server and the central server

daysOfWeekstring

Comma-separated list of days on which replication is active (for example, '1,2,3,4,5,6,7' represents Sunday through Saturday)

windowStartTimestring

Start time of the replication window in HH:mm format (for example, '08:00')

windowEndTimestring

End time of the replication window in HH:mm format (for example, '18:00')

createdTimestring

Timestamp indicating when the replication policy was created, formatted as 'MMM d, yyyy hh:mm a' (for example, 'Apr 8, 2026 02:57 PM')

modifiedTimestring

Timestamp indicating when the replication policy was last modified, formatted as 'MMM d, yyyy hh:mm a'

createdTimeInSecondsstring

Creation timestamp represented in epoch milliseconds

modifiedTimeInSecondsstring

Last modified timestamp represented in epoch milliseconds

userIDstring

Unique identifier of the user who created the replication policy

usernamestring

Username of the user who created the replication policy

associatedRemoteOfficeCountstring

Total number of remote offices currently associated with this replication policy

- HTTP code 404

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusCodestring

HTTP status code (404)

errorCodestring

Error code identifying the resource that was not found

messagestring

Error message describing the missing resource

Possible Response Codes

200HTTP code
404HTTP code

Sample Response: HTTP 200

Replication policy details

Copied!
  {
    "modifiedTime": "Apr 8, 2026 02:58 PM",
    "modifiedTimeInSeconds": "1775640497165",
    "windowStartTime": "08:00",
    "policyName": "Default Replication Policy",
    "windowEndTime": "18:00",
    "replicationInterval": 60,
    "replicationPolicyID": "1",
    "description": "Standard daily replication",
    "createdTimeInSeconds": "1736499600",
    "daysOfWeek": "1,2,3,4,5",
    "userID": "1",
    "dataTransferRateLAN": "2048",
    "createdTime": "Apr 8, 2026 02:57 PM",
    "associatedRemoteOfficeCount": 3,
    "dataTransferRate": "512",
    "username": "admin"
  }
                
Show full

Sample Response: HTTP 404

Replication policy not found

Copied!
  {
    "errorCode": "30027",
    "message": "Replication policy does not exist",
    "statusCode": 404
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.