Navigation

Take One On-Demand Snapshot

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 your Atlas username and API 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. If there is already a scheduled snapshot with a status of queued or inProgress, you may queue an on-demand snapshot.

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

Syntax

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

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name 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

curl --user "{username}:{apiKey}"
  --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

{
   "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"
}