# Update Cloud Backup Schedule for One Cluster

**PATCH /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/schedule**

Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role.


## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

#### Path parameters
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) 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.
- **clusterName** (string)
  Human-readable label that identifies the cluster.

#### Query parameters
- **envelope** (boolean)
  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.
- **pretty** (boolean)
  Flag that indicates whether the response body should be in the prettyprint format.

## Body parameters
Content-type: application/json
Updates the cloud backup schedule for one cluster within the specified project.

**Note**: In the request body, provide only the fields that you want to update.
- **autoExportEnabled** (boolean)
  Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket.
- **copySettings** (array[object])
  List that contains a document for each copy setting item in the desired backup policy.
- **deleteCopiedBackups** (array[object])
  List that contains a document for each deleted copy setting whose backup copies you want to delete.
- **deleteSnapshots** (boolean)
  Flag that indicates whether to delete Snapshots that MongoDB Cloud took previously when deleting the associated backup policy.
- **export** (object)
  Policy for automatically exporting Cloud Backup Snapshots.
- **extraRetentionSettings** (array[object])
  List that contains a document for each extra retention setting item in the desired backup policy.
- **policies** (array[object])
  Rules set for this backup schedule.
- **referenceHourOfDay** (integer(int32))
  Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot.
- **referenceMinuteOfHour** (integer(int32))
  Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot.
- **restoreWindowDays** (integer(int32))
  Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only.
- **updateSnapshots** (boolean)
  Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously.
- **useOrgAndGroupNamesInExportPrefix** (boolean)
  Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket.

## Responses
### 200: OK

#### Body Parameters: application/json (object)
- **autoExportEnabled** (boolean)
  Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket.
- **clusterId** (string)
  Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return.
- **clusterName** (string)
  Human-readable label that identifies the cluster with the Snapshot you want to return.
- **copySettings** (array[object])
  List that contains a document for each copy setting item in the desired backup policy.
- **export** (object)
  Policy for automatically exporting Cloud Backup Snapshots.
- **extraRetentionSettings** (array[object])
  List that contains a document for each extra retention setting item in the desired backup policy.
- **links** (array[object])
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
- **nextSnapshot** (string(date-time))
  Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- **policies** (array[object])
  Rules set for this backup schedule.
- **referenceHourOfDay** (integer(int32))
  Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot.
- **referenceMinuteOfHour** (integer(int32))
  Minute of the **referenceHourOfDay** that represents when MongoDB Cloud takes the Snapshot.
- **restoreWindowDays** (integer(int32))
  Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only.
- **useOrgAndGroupNamesInExportPrefix** (boolean)
  Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket.

### 400: Bad Request.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 401: Unauthorized.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403: Forbidden.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404: Not Found.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500: Internal Server Error.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)