Take One On-Demand Snapshot¶

On this page

Syntax
Response
Example Request
Example Response

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.

The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Take one on-demand snapshot. Atlas takes on-demand snapshots immediately, unlike scheduled snapshots which occur at regular intervals. If there is already an on-demand snapshot with a status of queued or inProgress, you must wait until Atlas has completed the on-demand snapshot before taking another.

You must have the Organization Owner or Project Owner role to successfully call this endpoint.

All requests to this endpoint must originate from an IP address on the Atlas user’s API whitelist. For complete documentation on configuring API whitelists, see Enable API Whitelisting for Your Organization.

Syntax¶

copy

POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/snapshots

Request Path Parameters¶

Path Element	Description
`GROUP-ID`	The unique identifier of the project for the Atlas cluster.
`CLUSTER-NAME`	The name of the Atlas cluster that contains the snapshots you want to retrieve.

Request Query Parameters¶

The following query parameters are optional:

Query Parameter	Type	Description	Default
`pretty`	boolean	Displays response in a prettyprint format.	`false`
`envelope`	boolean	Specifies whether or not to wrap the response in an envelope.	`false`

Request Body Parameters¶

Name	Type	Description
`description`	string	Required. Description of the on-demand snapshot.
`retentionInDays`	number	Required. The number of days that Atlas should retain the on-demand snapshot. Must be at least `1` .

Response¶

Name	Type	Description
`createdAt`	string	UTC ISO 8601 formatted point in time when Atlas took the snapshot.
`description`	string	Description of the snapshot. Only present for on-demand snapshots.
`expiresAt`	string	UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.
`id`	string	Unique identifier of the snapshot.
`links`	array	One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
`masterKeyUUID`	string	Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.
`mongodVersion`	string	Version of the MongoDB server.
`snapshotType`	string	Specified the type of snapshot. Valid values are `onDemand` and `scheduled`.
`status`	string	Current status of the snapshot. One of the following values: `queued` `inProgress` `completed` `failed`
`storageSizeBytes`	int	Specifies the size of the snapshot in bytes.
`type`	string	Specifies the type of cluster: `replicaSet` or `shardedCluster`.

Example Request¶

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
  --digest --include \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request POST "https://cloud.mongodb.com/api/atlas/v1.0/groups/6d2065c687d9d64ae7acdg41/clusters/Cluster0/backup/snapshots?pretty=true" \
  --data '{
      "description": "SomeDescription",
      "retentionInDays": 5
    }'

Example Response¶

copy

{
   "createdAt" : "2018-12-31T20:54:03Z",
   "description" : "SomeDescription ",
   "expiresAt" : "2019-01-05T20:54:03Z",
   "id" : "6d3b81eb87d9d61e37598558",
   "links" : [ {
     "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/6d2065c687d9d64ae7acdg41/clusters/Cluster0/backup/snapshots/6d3b81eb87d9d61e37598558",
     "rel" : "self"
   }, {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/6d2065c687d9d64ae7acdg41/clusters/Cluster0",
    "rel" : "http://mms.mongodb.com/cluster"
   } ],
   "mongodVersion" : "4.0.4",
   "snapshotType" : "onDemand",
   "status" : "queued",
   "storageSizeBytes" : 0,
   "type" : "replicaSet"
}

← Delete One Cloud Backup Cloud Backup Restore Jobs →