Navigation

Get Cloud Backup 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 authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

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

Syntax

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/backup/schedule

Request Path Parameters

Path Element Description
PROJECT-ID Unique identifier of the project for the Atlas cluster.
CLUSTER-NAME Name of the Atlas cluster that contains the snapshot 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

This endpoint does not use HTTP request body parameters.

Response

Name Type Description
clusterId string 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 string UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
policies array of objects A list of policy definitions for the cluster.
policies.id string Unique identifier of the backup policy.
policies.policyitems array of objects A list of specifications for a policy.
policies.policyitems.frequencyInterval number The frequency interval for a set of snapshots.
policies.policyitems.frequencyType string

A type of frequency. Possible values are:

  • hourly
  • daily
  • weekly
  • monthly
id string Unique identifier for this policy item.
policies.policyitems.retentionUnit string

The unit of time in which snapshot retention is measured. Possible values are:

  • days
  • weeks
  • months
policies.policyitems.retentionValue number The number of days, weeks, or months the snapshot is retained.
restoreWindowDays number Specifies a restore window in days for the cloud provider backup to maintain.
referenceHourOfDay number UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
referenceMinuteOfHour number UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/clusters/MyCluster/backup/schedule"

Example Response

{
  "clusterId" : "5e2f1bcaf38990fab9227b8",
  "clusterName" : "myCluster",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}/clusters/myCluster/backup/schedule",
    "rel" : "self"
  }, {
    "href" : "https://cloud.mongodb.com/api/atlas/v1.0/groups/{PROJECT-ID}",
    "rel" : "http://mms.mongodb.com/group"
  } ],
  "nextSnapshot" : "2020-01-28T05:24:25Z",
  "policies" : [ {
    "id" : "5e2f1bcaf38990fab9227b8",
    "policyItems" : [ {
      "frequencyInterval" : 6,
      "frequencyType" : "hourly",
      "id" : "5e2f1cc8105eef6d6bd9005b",
      "retentionUnit" : "days",
      "retentionValue" : 7
    }, {
      "frequencyInterval" : 1,
      "frequencyType" : "daily",
      "id" : "5e2f1cc8105eef6d6bd9005c",
      "retentionUnit" : "days",
      "retentionValue" : 7
    }, {
      "frequencyInterval" : 6,
      "frequencyType" : "weekly",
      "id" : "5e2f1cc8105eef6d6bd9005d",
      "retentionUnit" : "weeks",
      "retentionValue" : 4
    }, {
      "frequencyInterval" : 40,
      "frequencyType" : "monthly",
      "id" : "5e2f1cc8105eef6d6bd9005e",
      "retentionUnit" : "months",
      "retentionValue" : 12
    } ]
  } ],
  "referenceHourOfDay" : 17,
  "referenceMinuteOfHour" : 24,
  "restoreWindowDays" : 7
}