Return One Legacy Backup Checkpoint

Deprecated

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}

Copy endpoint

https://cloud.mongodb.com

Returns one legacy backup checkpoint 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.

Parameters

path Path Parameters

Name	Type
`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
`checkpointId` required Unique 24-hexadecimal digit string that identifies the checkpoint.	string
`clusterName` required Human-readable label that identifies the cluster that contains the checkpoints that you want to return.	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

Responses

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

interface ApiAtlasCheckpointView {
clusterId?: string;
completed?: string;
groupId?: string;
id?: string;
links?: readonly

Link

interface Link {
href?: string;
rel?: string;
}

[];
parts?: readonly

ApiCheckpointPartView

Metadata contained in one document that describes the complete snapshot taken for this node.

interface ApiCheckpointPartView {
replicaSetName?: string;
shardName?: string;
tokenDiscovered?: boolean;
tokenTimestamp?: ApiBSONTimestampView;
typeName?: "REPLICA_SET" | "CONFIG_SERVER" | "CONFIG_SERVER_REPLICA_SET";
}

[];
restorable?: boolean;
started?: string;
timestamp?: 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;
}

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;
}