Navigation

Get All Cloud Provider Snapshots

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

Syntax

GET /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:

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Number of items to return per page, up to a maximum of 500. 100
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

This endpoint does not use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.

Name Type Description
results object array Includes one object for each item detailed in the results array section.
links object array Includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results array

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 GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5b6212af90dc76637950a2c6/clusters/MyCluster/backup/snapshots"

Example Response

{
    "links": [
        {
            "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5b6212af90dc76637950a2c6/clusters/MyCluster/backup/snapshots?pageNum=1&itemsPerPage=100",
            "rel": "self"
        }
    ],
    "results": [
        {
            "createdAt": "2018-08-01T20:02:07Z",
            "expiresAt": "2018-08-04T20:03:11Z",
            "id": "5b6211ff87d9d663c59d3feg",
            "links": [
                {
                    "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5b6212af90dc76637950a2c6/clusters/MyCluster/backup/snapshots/5b6211ff87d9d663c59d3feg",
                    "rel": "self"
                },
                {
                    "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5b6212af90dc76637950a2c6/clusters/MyCluster",
                    "rel": "http://mms.mongodb.com/cluster"
                }
            ],
            "mongodVersion": "3.6.6",
            "storageSizeBytes": 1778012160,
            "type" : "replicaSet"
        }
    ],
    "totalCount": 1
}