Modify Cloud Backup Backup Policy¶
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.
All requests to this endpoint must originate from an IP address in the organization's API access list.
https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
PATCH /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/schedule
Request Parameters¶
Request Path Parameters¶
Parameter | Type | Description |
---|---|---|
GROUP-ID | string | Unique identifier of the project for the
Atlas cluster. |
CLUSTER-NAME | string | Name of the Atlas cluster that contains the snapshot
you want to retrieve. |
Request Query Parameters¶
This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
policies[] | array | Required | Array containing a document for each backup policy item in the
desired updated backup policy. |
policies[i] .id | string | Required | Unique identifier of the backup policy that you want to update. |
policies[i] .policyItems[] | array | Required | Array of backup policy items. |
policies[i] .policyItems[n] .frequencyInterval | number | Required | Desired frequency of the new backup policy item specified by
Example
The following frequency values are valid:
|
policies[i] .policyItems[n] .frequencyType | string | Required | Frequency associated with the backup policy item. One of the
following values: Note You cannot specify multiple |
policies[i] .policyItems[n] .id | string | Required | Unique identifier of the backup policy item. |
policies[i] .policyItems[n] .retentionUnit | string | Required | Scope of the backup policy item: days , weeks , or
months . |
policies[i] .policyItems[n] .retentionValue | string | Required | Value to associate with Note Atlas requires that the value specified for
|
referenceHourOfDay | number | Optional | UTC Hour of day between 0 and 23 , inclusive,
representing which hour of the day that Atlas takes
snapshots for backup policy items. |
referenceMinuteOfHour | number | Optional | UTC Minutes after referenceHourOfDay that Atlas takes
snapshots for backup policy items. Must be between 0 and
59 , inclusive. |
restoreWindowDays | number | Optional | Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer. Applies to continuous cloud backups only. |
updateSnapshots | boolean | Optional | Specify true to apply the retention changes in
the updated backup policy to snapshots that Atlas took
previously. |
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 URL |