Navigation

Modify Cloud Provider Snapshot Schedule

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.

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 Provide Access to Whitelisted API Operations.

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

Syntax

PATCH /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/schedule

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 snapshot 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 Display response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

Each of the following parameters are optional:

Name Type Description
numOfSnapshotsToRetain int Number of snapshots Atlas retains for the cluster. If the provided value is lower than the currently configured numOfSnapshotsToRetain, Atlas automatically deletes the oldest stored snapshots until the total number of snapshots matches the configured value.
referenceHourOfDay int UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot. The first snapshot taken after updating the snapshot schedule occurs within 24 hours, breaking the default behavior of one snapshot every 24 hours. All subsequent snapshots occur once every 24 hours at the configured point in time.
referenceMinuteOfHour int UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot. The first snapshot taken after updating the snapshot schedule occurs within 24 hours, breaking the default behavior of one snapshot every 24 hours. All subsequent snapshots occur once every 24 hours at the configured point in time.

Response

Name Type Description
clusterId ObjectId Unique identifier of the Atlas cluster.
clusterName String Name of the Atlas cluster.
links array One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
nextSnapshot date UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
numOfSnapshotsToRetain int Number of snapshots Atlas retains for the cluster.
referenceHourOfDay int UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
referenceMinuteOfHour int UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.

Example Request

curl --user "{username:apiKey}" --digest --include \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/groups/5b6212af90dc76637950a2c6/clusters/MyCluster/backup/schedule" \
  --data '
    {
      "numOfSnapshotsToRetain" : 5
      "referenceHourOfDay" : 18
      "referenceMinuteOfDay" : 30
    }
  '

Example Response

{
    "clusterId": "5b6206f680eef53690a575b6",
    "clusterName": "MyCluster",
    "links": [
        {
            "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5b6212af90dc76637950a2c6/clusters/MyCluster/backup/schedule",
            "rel": "self"
        },
        {
            "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5b6212af90dc76637950a2c6",
            "rel": "http://mms.mongodb.com/group"
        }
    ],
    "nextSnapshot": "2018-08-02T20:01:58Z",
    "numOfSnapshotsToRetain": 5,
    "referenceHourOfDay": 18,
    "referenceMinuteOfHour": 30
}