# Return One Snapshot Schedule

**GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule**

Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

 Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation.

[Cloud Backup Documentation](https://www.mongodb.com/zh-cn/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule)

## 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 with the snapshot you want to return.

### 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.


## Responses
### 200
OK

#### Body: application/vnd.atlas.2023-01-01+json (object)
- **clusterCheckpointIntervalMin** (integer(int32))
  Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.
- **clusterId** (string)
  Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.
- **dailySnapshotRetentionDays** (integer(int32))
  Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to `0` to disable daily snapshot retention.
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies the project that contains the cluster.
- **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.
- **monthlySnapshotRetentionMonths** (integer(int32))
  Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to `0` to disable monthly snapshot retention.
- **pointInTimeWindowHours** (integer(int32))
  Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot.
- **snapshotIntervalHours** (integer(int32))
  Number of hours that must elapse before taking another snapshot.
- **snapshotRetentionDays** (integer(int32))
  Number of days that MongoDB Cloud must keep recent snapshots.
- **weeklySnapshotRetentionWeeks** (integer(int32))
  Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to `0` to disable weekly snapshot retention.

### 401
Unauthorized.

#### Body: 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: 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: 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: 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)