Docs Menu

Docs HomeMongoDB Cluster-to-Cluster Sync

resume

On this page

  • Description
  • Requirement
  • Request
  • Request Body Parameters
  • Response
  • Example
  • Request
  • Response
  • Behavior

Resumes a paused synchronization session based on data stored on the destination cluster.

To use the resume endpoint, mongosync must be in the PAUSED state.

POST /api/v1/resume

This endpoint does not use HTTP request body parameters. However, you must specify the --data option with an empty object { }.

Field
Type
Description
success
boolean
When the request is successful, this value is true.
error
string
If an error occurred, indicates the name of the error. This field is omitted from the response when success is true.
errorDescription
string
Detailed description of the error that occurred. This field is omitted from the response when success is true.

The following example resumes a paused synchronization operation.

curl localhost:27182/api/v1/resume -XPOST --data '{ }'
{"success":true}

If the resume request is successful, mongosync enters the RUNNING state.

←  pausecommit →
Share Feedback