Update an existing 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

Updates an existing replication policy with modified transfer rates, schedule, and time window configuration.

Request URL

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

Scope

SOM.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/replicationPolicyDetails.v1+jsonapplication/replicationPolicyDetails.v1+jsonCopied!
AcceptstringMandatory
application/replicationPolicyUpdatedStatus.v1+jsonapplication/replicationPolicyUpdatedStatus.v1+jsonCopied!

- Path Parameters

replication_policy_idstringMandatory

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

- Request Body

application/json
JSON Object
Hide Sub-Attributes
policyNamestringOptional

Administrator-defined display name for the replication policy (max 250 characters)

descriptionstringOptional

Optional administrator-provided description for the replication policy (max 1000 characters)

replicationIntervalstringOptional

Interval in minutes at which the Distribution Server syncs data with the central server

daysOfWeekstringOptional

Comma-separated day numbers when replication is active: 1=Sunday through 7=Saturday (e.g., '2,3,4,5,6' for weekdays only)

windowStartTimestringOptional

Start time of the replication window in HH:mm format (e.g., '08:00'). Replication is allowed only between the start and end times

windowEndTimestringOptional

End time of the replication window in HH:mm format (e.g., '18:00'). Replication is allowed only between the start and end times

dataTransferRatestringOptional

WAN data transfer rate limit in Kbps. Set to 0 for unlimited bandwidth, or specify a value from: 16, 32, 64, 128, 256, 512, 1024, 2048, 3072, 4096, 5120, 6144, 7168, 8192

dataTransferRateLANstringOptional

LAN data transfer rate limit in Kbps. Set to 0 for unlimited bandwidth, or specify a value from: 16, 32, 64, 128, 256, 512, 1024, 2048, 3072, 4096, 5120, 6144, 7168, 8192

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/dcapi/som/replication-policies/{replication_policy_id} \
  --header 'Accept: application/replicationPolicyUpdatedStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/replicationPolicyDetails.v1+json' \
  --data '{"windowStartTime":"09:00","policyName":"Business Hours Only","windowEndTime":"17:00","replicationInterval":30,"description":"Replicate only during business hours","dataTransferRate":256,"daysOfWeek":"1,2,3,4,5"}'

Sample Request Body

Update a business-hours replication policy

Copied!
  {
    "windowStartTime": "09:00",
    "policyName": "Business Hours Only",
    "windowEndTime": "17:00",
    "replicationInterval": 30,
    "description": "Replicate only during business hours",
    "dataTransferRate": 256,
    "daysOfWeek": "1,2,3,4,5"
  }
                
Show full

Response Parameters

- HTTP code 200

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

Indicates whether the replication policy update or deletion completed successfully

messagestring

Descriptive message confirming the operation or explaining the reason for failure (e.g., 'Replication policy - Business Hours Only has been updated successfully')

- 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

- HTTP code 412

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

HTTP status code (412)

errorCodestring

Precondition failed error code identifying the business logic violation

messagestring

Error message describing the precondition failed while processing request

Possible Response Codes

200HTTP code
404HTTP code
412HTTP code

Sample Response: HTTP 200

Policy updated

Copied!
  {
    "message": "Replication policy - Business Hours Only has been updated successfully",
    "status": true
  }
                
Show full

Sample Response: HTTP 404

Replication policy not found

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

Sample Response: HTTP 412

Required replication policy parameters are missing

Copied!
  {
    "errorCode": "30090",
    "message": "Required replication policy parameters are missing",
    "statusCode": 412
  }
                
Show full

Invalid replication interval or insufficient replication window

Copied!
  {
    "errorCode": "30086",
    "message": "Invalid replication interval or insufficient replication window",
    "statusCode": 412
  }
                
Show full

Replication policy with same name already exists

Copied!
  {
    "errorCode": "30025",
    "message": "A replication policy with the same name already exists",
    "statusCode": 412
  }
                
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.