Return All Legacy Backup Restore Jobs

Deprecated

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs

Copy endpoint

https://cloud.mongodb.com

Returns all legacy backup restore jobs 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. If you use the BATCH-ID query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.

Parameters

path Path Parameters

Name Type

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
`clusterName` required Human-readable label that identifies the cluster with the snapshot you want to return.	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

clusterName required

Human-readable label that identifies the cluster with the snapshot 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
`includeCount` Flag that indicates whether the response returns the total number of items (totalCount) in the response.	boolean
`itemsPerPage` Number of items that the response returns per page.	number
`pageNum` Number of the page that displays the current set of the total objects that the response returns.	number
`pretty` Flag that indicates whether the response body should be in the prettyprint format.	boolean
`batchId` Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.	string

Responses

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

interface PaginatedRestoreJobView {
links?: readonly

Link

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

[];
results?: readonly

BackupRestoreJob

interface BackupRestoreJob {
batchId?: string;
checkpointId?: string;
clusterId?: string;
clusterName?: string;
created?: string;
delivery: BackupRestoreJobDelivery;
deploymentJobId?: string;
encryptionEnabled?: boolean;
groupId?: string;
hashes?: readonly RestoreJobFileHash[];
id?: string;
links?: readonly Link[];
masterKeyUUID?: string;
oplogInc?: number;
oplogTs?: string;
pointInTimeUTCMillis?: number;
snapshotId?: string;
statusName?: "IN_PROGRESS" | "BROKEN" | "KILLED" | "FINISHED";
timestamp?: ApiBSONTimestampView;
}

[];
totalCount?: number;
}

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