Get All Cloud Backup Snapshot Export Jobs¶
On this page
The /backup/exports resource enables you to retrieve all backup
snapshot export jobs associated with the specified Atlas cluster.
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.
The Atlas Administration API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Get Started with the Atlas Administration API.
Resource¶
https://cloud.mongodb.com/api/atlas/v1.0
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/exports/
Request Path Parameters¶
Path Parameter | Type | Necessity | Description |
|---|---|---|---|
GROUP-ID | string | Required | Unique 24-hexadecimal digit string that identifies the
project which contains the Atlas cluster
whose snapshot you want to export. |
CLUSTER-NAME | string | Required | Name of the Atlas cluster whose snapshot you want to
export. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Atlas Administration API resources. These are all optional.
Name | Type | Necessity | Description | Default |
|---|---|---|---|---|
pageNum | integer | Optional | Page number, starting with one, that Atlas returns of the
total number of objects. | 1 |
itemsPerPage | integer | Optional | Number of items that Atlas returns per page, up to a maximum
of 500. | 100 |
includeCount | boolean | Optional | Flag that indicates whether Atlas returns the totalCount
parameter in the response body. | true |
pretty | boolean | Optional | Flag that indicates whether Atlas returns the JSON
response in the
prettyprint format. | false |
envelope | boolean | Optional | Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Request Body Parameters¶
This endpoint doesn't use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
|---|---|---|
results | array of objects | One object for each item detailed in the
results Embedded Document
section. |
links | array of objects | One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification |
totalCount | integer | Count of the total number of items in the result set. It may
be greater than the number of objects in the results
array if the entire result set is paginated. |
results Embedded Document¶
Name | Type | Description | |
|---|---|---|---|
components | array of documents | Returned for sharded clusters only. Export job details for each replica set in the sharded cluster. | |
components.exportId | string | Returned for sharded clusters only. Unique identifier of the export job for the replica set. | |
components.replicaSetName | string | Returned for sharded clusters only. Name of the replica set. | |
createdAt | string | Timestamp in ISO 8601 date and time format in UTC when the export job was created. | |
customData | array of documents | Custom data for the metadata file named .complete that
Atlas uploads to the bucket when the export job finishes. | |
customData.key | string | Custom data specified as key in the key and value pair. | |
customData.value | string | Value for the key specified using customData.key. | |
errMsg | string | Error message, only if the export job failed. | |
exportBucketId | string | Unique identifier of the bucket. | |
exportStatus | document | Returned for replica set only. Status of the export job. | |
exportStatus.exportedCollections | int | Returned for replica set only. Number of collections that have been exported. | |
exportStatus.totalCollections | int | Returned for replica set only. Total number of collections to export. | |
finishedAt | string | Timestamp in ISO 8601 date and time format in UTC when the export job completes. | |
id | string | Unique identifier of the export job. | |
prefix | string | Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format: | |
snapshotId | string | Unique identifier of the snapshot. | |
state | string | Status of the export job. Value can be one of the following:
|
Example Request¶
1 curl --user "{publicApiKey}:{privateApiKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/exports/"