Take One On-Demand Snapshot

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots

Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of queued or inProgress exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot.

To use this resource, the requesting API Key must have the Project Owner role.

Path parameters

groupId string Required

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.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
clusterName string Required

Human-readable label that identifies the cluster.

Minimum length is 1, maximum length is 64. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

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.

Default value is false.
pretty boolean

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

Default value is false.

application/vnd.atlas.2023-01-01+json

Body Required

Takes one on-demand snapshot.

description string

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status" : "onDemand".
retentionInDays integer(int32)

Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least 1.

Minimum value is 1.

Responses

200 application/vnd.atlas.2023-01-01+json

OK
One of:
replicaSet object shardedCluster object
Details of the replica set snapshot that MongoDB Cloud created.

Hide attributes Show attributes

createdAt string(date-time)

Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

description string

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status": "onDemand".

expiresAt string(date-time)

Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

frequencyType string

Human-readable label that identifies how often this snapshot triggers.

Values are hourly, daily, weekly, monthly, or yearly.

id string

Unique 24-hexadecimal digit string that identifies the snapshot.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

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.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

masterKeyUUID string(uuid)

Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when "encryptionEnabled" : true.

mongodVersion string

Version of the MongoDB host that this snapshot backs up.

Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).

policyItems array[string]

List that contains unique identifiers for the policy items.

Minimum length of each is 24, maximum length of each is 24. Format of each should match the following pattern: ^([a-f0-9]{24})$.

snapshotType string

Human-readable label that identifies when this snapshot triggers.

Values are onDemand or scheduled.

status string

Human-readable label that indicates the stage of the backup process for this snapshot.

Values are queued, inProgress, completed, or failed.

storageSizeBytes integer(int64)

Number of bytes taken to store the backup at time of snapshot.

type string Discriminator

Human-readable label that categorizes the cluster as a replica set or sharded cluster.

Value is replicaSet.

cloudProvider string

Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when "type": "replicaSet".

Values are AWS, AZURE, or GCP.

copyRegions array[string]

List that identifies the regions to which MongoDB Cloud copies the snapshot.

replicaSetName string

Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when "type": "replicaSet".
Details of the sharded cluster snapshot that MongoDB Cloud created.

Hide attributes Show attributes

createdAt string(date-time)

Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

description string

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status": "onDemand".

expiresAt string(date-time)

Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

frequencyType string

Human-readable label that identifies how often this snapshot triggers.

Values are hourly, daily, weekly, monthly, or yearly.

id string

Unique 24-hexadecimal digit string that identifies the snapshot.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

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.

Web Linking Specification (RFC 5988)

Hide links attributes Show links attributes object

href string

Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.

rel string

Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.

masterKeyUUID string(uuid)

Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when "encryptionEnabled" : true.

mongodVersion string

Version of the MongoDB host that this snapshot backs up.

Format should match the following pattern: ([\d]+\.[\d]+\.[\d]+).

policyItems array[string]

List that contains unique identifiers for the policy items.

Minimum length of each is 24, maximum length of each is 24. Format of each should match the following pattern: ^([a-f0-9]{24})$.

snapshotType string

Human-readable label that identifies when this snapshot triggers.

Values are onDemand or scheduled.

status string

Human-readable label that indicates the stage of the backup process for this snapshot.

Values are queued, inProgress, completed, or failed.

storageSizeBytes integer(int64)

Number of bytes taken to store the backup at time of snapshot.

type string Discriminator

Human-readable label that categorizes the cluster as a replica set or sharded cluster.

Value is shardedCluster.

configServerType string

Human-readable label that identifies the config server type for this snapshot.

Values are EMBEDDED or DEDICATED.

members array[object]

List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when "type" : "SHARDED_CLUSTER".

Hide members attributes Show members attributes object

cloudProvider string Required

Human-readable label that identifies the cloud provider that stores this snapshot. The resource returns this parameter when "type": "replicaSet".

Values are AWS, AZURE, or GCP.

id string Required

Unique 24-hexadecimal digit string that identifies the snapshot.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

replicaSetName string Required

Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot.

snapshotIds array[string]

List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when "type": "SHARDED_CLUSTER". These identifiers should match the ones specified in the members[n].id parameters. This allows you to map a snapshot to its shard or config host name.

Minimum length of each is 24, maximum length of each is 24. Format of each should match the following pattern: ^([a-f0-9]{24})$.
400 application/json

Bad Request.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- 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 application/json

Not Found.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- 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 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- 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.

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots

atlas api cloudBackups takeSnapshot --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.TakeSnapshotApiParams{}
	sdkResp, httpResp, err := client.CloudBackupsApi.
		TakeSnapshotWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \
  -d '{ <Payload> }'

Request examples

{
  "description": "string",
  "retentionInDays": 42
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "description": "string",
  "expiresAt": "2025-05-04T09:42:00Z",
  "frequencyType": "hourly",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "masterKeyUUID": "string",
  "mongodVersion": "string",
  "policyItems": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "snapshotType": "onDemand",
  "status": "queued",
  "storageSizeBytes": 42,
  "type": "replicaSet",
  "cloudProvider": "AWS",
  "copyRegions": [
    "string"
  ],
  "replicaSetName": "string"
}

{
  "createdAt": "2025-05-04T09:42:00Z",
  "description": "string",
  "expiresAt": "2025-05-04T09:42:00Z",
  "frequencyType": "hourly",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "masterKeyUUID": "string",
  "mongodVersion": "string",
  "policyItems": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "snapshotType": "onDemand",
  "status": "queued",
  "storageSizeBytes": 42,
  "type": "shardedCluster",
  "configServerType": "EMBEDDED",
  "members": [
    {
      "cloudProvider": "AWS",
      "id": "32b6e34b3d91647abb20e7b8",
      "replicaSetName": "string"
    }
  ],
  "snapshotIds": [
    "32b6e34b3d91647abb20e7b8"
  ]
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}