MOmongodb
Cloud Backups

Create One Collection Restore Job

Creates one collection-level restore job for one cluster from the specified project. Collection-level restores allow restoring specific databases or collections from a snapshot or point-in-time.

post/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collectionRestoreJobs

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collectionRestoreJobs
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

clusterNamestring required

Human-readable label that identifies the source cluster for the restore.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

collectionSuffixstring nullable

Optional suffix applied to restored collection names.

databaseSuffixstring nullable

Optional suffix applied to restored database names.

indexStrategy'ALL' | 'NONE' | 'ALL_EXCEPT_TTL' required

Strategy for restoring indexes (all, none, or all except TTL).

oplogIncinteger nullable

Oplog increment for point-in-time restore.

oplogTsinteger nullable

Oplog timestamp (seconds part) for point-in-time restore.

pointInTimeUtcSecondsinteger nullable

Point-in-time restore time in seconds since UNIX epoch.

snapshotIdstring

ID of the snapshot to restore.

targetClusterNamestring required

Target cluster name.

targetGroupIdstring required

Unique 24-hexadecimal digit string that identifies the target group.

writeStrategy'CREATE_NEW' | 'OVERWRITE_EXISTING' required

Strategy for writing data on the target (create as new or overwrite existing). With OVERWRITE_EXISTING, any writes to the affected databases or collections during the restore will be lost when the existing namespaces are dropped and replaced. To avoid data loss, stop writes to the affected namespaces before starting the restore.

Example request

{
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "targetGroupId": "32b6e34b3d91647abb20e7b8"
}

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.