> For the complete MongoDB documentation index, see www.mongodb.com/docs/llms.txt

# `resume`

## Description

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

## Requirement

To use the `resume` endpoint, `mongosync` must be in the [PAUSED](https://www.mongodb.com/docs/mongosync/current/reference/mongosync-states.md#std-label-c2c-state-paused) state.

**Note:**

When you configure multiple `mongosync` instances to sync between sharded clusters, you must send identical API endpoint commands to each `mongosync` instance.

For more information, see [Resume Multiple Mongosyncs.](https://www.mongodb.com/docs/mongosync/current/topologies/multiple-mongosyncs.md#std-label-c2c-sharded-resume)

## Request

```http
POST /api/v1/resume 

```

### Request Body Parameters

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

## Response

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

## Example

The following example resumes a paused synchronization operation.

### Request

```shell
curl localhost:27182/api/v1/resume -XPOST --data '{ }'

```

### Response

```shell
{"success":true}

```

## Behavior

- When you send a `resume` request, `mongosync` might take at least two minutes before resuming the migration. To see if the migration resumed, you can call the [`progress`](https://www.mongodb.com/docs/mongosync/current/reference/api/progress.md#std-label-c2c-api-progress) endpoint.

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

### Endpoint Protection

`mongosync` does not protect the `resume` endpoint.  However, by default the API binds to localhost only and does not accept calls from other sources. Additionally, the `resume` call does not expose connection credentials or user data.