XDCR API
- reference
The XDCR REST API is used to manage Cross Datacenter Replication (XDCR) operations.
Description
Cross Datacenter Replication (XDCR) configuration replicates data between a source bucket and a target bucket. For a detailed introduction and overview, see Cross Data Center Replication (XDCR).
| HTTP method | URI path | Description | Admin Role |
|---|---|---|---|
GET |
/pools/default/remoteClusters |
Retrieves the destination cluster reference |
Full, Cluster, Replication |
POST |
/pools/default/remoteClusters |
Creates a reference to the destination cluster |
Full, Cluster, Replication |
POST |
/pools/default/remoteClusters/[Name] |
Modifies the destination cluster reference. |
Full, Cluster, Replication |
DELETE |
/pools/default/remoteClusters/[Name] |
Deletes the reference to the destination cluster. |
Full, Cluster, Replication |
GET |
/pools/default/certificate |
Retrieves the certificate from the cluster. |
Full, Cluster |
POST |
/controller/regenerateCertificate |
Regenerates a certificate on a destination cluster. |
Full, Cluster |
DELETE |
/controller/cancelXDCR/[replication_id] |
Deletes the replication. |
Full, Cluster |
GET, POST |
/settings/replications/ |
Global setting supplied to all replications for a cluster. |
Full, Cluster |
GET, POST |
/settings/replications/[replication_id] |
Settings for a specific replication for a bucket. |
Full, Cluster |
GET |
/pools/default/buckets/@xdcr[bucket_name]/ \ stats/[destination_endpoint]_ |
Retrieves bucket statistics. |
Full, Cluster, Replication |