Create a new replication policy

Creates a new replication policy with transfer rates, schedule, and time window configuration.

Endpoints

post /dcapi/som/replication-policies

Copy full URL

Request URL

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

Scope

SOM.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/replicationPolicyDetails.v1+jsonCopied!

AcceptstringMandatory

application/replicationPolicyAddStatus.v1+jsonCopied!

- 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 POST \
  --url https://appdomain/dcapi/som/replication-policies \
  --header 'Accept: application/replicationPolicyAddStatus.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"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/dcapi/som/replication-policies"))
        .header("Content-Type", "application/replicationPolicyDetails.v1+json")
        .header("Accept", "application/replicationPolicyAddStatus.v1+json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"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\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"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\"}"

headers = {
    'Content-Type': "application/replicationPolicyDetails.v1+json",
    'Accept': "application/replicationPolicyAddStatus.v1+json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/dcapi/som/replication-policies", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/replicationPolicyDetails.v1+json");
    headersMap.put("Accept", "application/replicationPolicyAddStatus.v1+json");

    data=Map();
    data.put("policyName","value");
    data.put("description","value");
    data.put("replicationInterval","value");
    data.put("daysOfWeek","value");
    data.put("windowStartTime","value");
    data.put("windowEndTime","value");
    data.put("dataTransferRate","value");
    data.put("dataTransferRateLAN","value");

    response = invokeUrl
    [
        url: "https://appDomain/dcapi/som/replication-policies"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/replicationPolicyDetails.v1+json")
$headers.Add("Accept", "application/replicationPolicyAddStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/som/replication-policies' -Method POST -Headers $headers -ContentType 'application/replicationPolicyDetails.v1+json' -Body '{"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

Create 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 was created successfully

messagestring

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

dataJSON Object

Contains the identifier of the newly created replication policy

Show Sub-Attributes

replicationPolicyIDstring

Unique identifier of the newly created replication policy

- 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

412HTTP code

Sample Response: HTTP 200

Policy created

Copied!

  {
    "data": {
      "replicationPolicyID": 5
    },
    "message": "Replication policy - Business Hours Only has been created successfully",
    "status": true
  }

▼ 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.