A newer version of this documentation is available.

View Latest

Pausing XDCR Replication Streams

  • reference
    +
    XDCR replication is paused and resumed using the /settings/replications/ URI path and the pauseRequested option.

    HTTP method and URI

    POST /settings/replications/[replication_id]
    Table 1. XDCR URI paths for settings
    URI path Description

    /settings/replications/[replication_id]

    Settings for specific replication for a bucket,where replication_id is

    {{[ REMOTE UUID]%2F[LOCAL BUCKET]%2[REMOTE BUCKET]}}

    Table 2. XDCR advanced settings
    Parameter Value Description

    pauseRequested

    Boolean (true or false)

    Specify true to pause the replication. Specify false to continue replication. Initially set to false.

    Syntax

    # curl -X POST -u [ admin ]:[ password ] http://[ localhost ]:8091/settings/replications/[replication_id] \
    -d pauseRequested=[ true | false ]

    Examples

    $ curl -X POST -u Administrator:password http://172.23.106.139:8091/settings/replications/61fbe91e224ff5f5177799f26483861d%2Fdefault%2Fdefault \
     -d pauseRequested=true
    { "checkpointInterval":1800,
      "docBatchSizeKb":2048,
      "failureRestartInterval":10,
      "filterExpression":"",
      "logLevel":"Info",
      "optimisticReplicationThreshold":256,
      "pauseRequested":true,
      "sourceNozzlePerNode":2,
      "statsInterval":1000,
      "targetNozzlePerNode":2,
      "type":"xmem",
      "workerBatchSize":500 }