MOmongodb
Cloud Backups

Update Backup Compliance Policy Settings

Updates the Backup Compliance Policy settings for the specified project.

put/api/atlas/v2/groups/{groupId}/backupCompliancePolicy

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

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.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

overwriteBackupPoliciesboolean

Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

authorizedEmailstring email required

Email address of the user who authorized to update the Backup Compliance Policy settings.

authorizedUserFirstNamestring

First name of the user who authorized to update the Backup Compliance Policy settings.

authorizedUserLastNamestring

Last name of the user who authorized to update the Backup Compliance Policy settings.

copyProtectionEnabledboolean

Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false.

deletableboolean

Flag that indicates whether the Backup Compliance Policy is allowed to be disabled. It is default to false and a support ticket needs to be filed to request setting to true.

encryptionAtRestEnabledboolean

Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.

pitEnabledboolean

Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.

projectIdstring

Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.

restoreWindowDaysinteger

Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.

state'ACTIVE' | 'ENABLING' | 'UPDATING' | 'DISABLING'

Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.

updatedDatestring date-time

ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.

updatedUserstring email

Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.

Example request

{
  "onDemandPolicyItem": {
    "id": "32b6e34b3d91647abb20e7b8"
  },
  "projectId": "32b6e34b3d91647abb20e7b8",
  "scheduledPolicyItems": [
    {
      "id": "32b6e34b3d91647abb20e7b8"
    }
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.