Toolcog home
Search ⌘ + K

Command Palette

Search for a command to run...

Sign In

Download One M2 or M5 Cluster Snapshot

Deprecated
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download
Copy endpoint
https://cloud.mongodb.com

Requests one snapshot for the specified shared cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role.

This endpoint can also be used on Flex clusters that were created using the createCluster endpoint or former M2/M5 clusters that have been migrated to Flex clusters until January 22, 2026, after which this endpoint will be sunset. Please use the downloadFlexBackup endpoint instead.

Parameters

path Path Parameters

Name Type
clusterName required

Human-readable label that identifies the cluster.
string
groupId 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.
string

query Query Parameters

Name Type
envelope

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.
boolean
pretty

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

Request Body

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

Snapshot to be downloaded.

interface TenantRestore {
clusterName?: string;
deliveryType?: "RESTORE" | "DOWNLOAD";
expirationDate?: string;
id?: string;
links?: readonly Link
interface Link {
href?: string;
rel?: string;
}
[];
projectId?: string;
restoreFinishedDate?: string;
restoreScheduledDate?: string;
snapshotFinishedDate?: string;
snapshotId: string;
snapshotUrl?: string;
status?: "PENDING" | "QUEUED" | "RUNNING" | "FAILED" | "COMPLETED";
targetDeploymentItemName: string;
targetProjectId?: string;
}

Responses

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

OK

interface TenantRestore {
clusterName?: string;
deliveryType?: "RESTORE" | "DOWNLOAD";
expirationDate?: string;
id?: string;
links?: readonly Link
interface Link {
href?: string;
rel?: string;
}
[];
projectId?: string;
restoreFinishedDate?: string;
restoreScheduledDate?: string;
snapshotFinishedDate?: string;
snapshotId: string;
snapshotUrl?: string;
status?: "PENDING" | "QUEUED" | "RUNNING" | "FAILED" | "COMPLETED";
targetDeploymentItemName: string;
targetProjectId?: string;
}

Client Errors

400 application/json

Bad Request.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
401 application/json

Unauthorized.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
403 application/json

Forbidden.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
404 application/json

Not Found.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
409 application/json

Conflict.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

Server Errors

500 application/json

Internal Server Error.

interface ApiError {
badRequestDetail?: BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}
;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}