Navigation

Get One Cloud Backup Snapshot Export Job

The /backup/exports resource enables you to retrieve one backup snapshot export job specified by its ID.

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.

The Atlas 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 Configure Atlas API Access.

https://cloud.mongodb.com/api/atlas/v1.0

GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/exports/{EXPORT-JOB-ID}
Path Parameter
Type
Necessity
Description
GROUP-ID
string
Required
Unique 24-hexadecimal digit string that identifies the project which contains the Atlas cluster whose export job you want to retrieve.
CLUSTER-NAME
string
Required
Name of the Atlas cluster whose export job you want to retrieve.
EXPORT-JOB-ID
string
Required
Unique identifier of the export job to retrieve. If necessary, use Get All Cloud Backup Snapshot Export Jobs to retrieve the list of export jobs for the cluster.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

status
HTTP response code
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

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:

/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}
snapshotId
string
Unique identifier of the snapshot.
state
string

Status of the export job. Value can be one of the following:

  • Queued - indicates that the export job is queued
  • InProgress - indicates that the snapshot is being exported
  • Successful - indicates that the export job has completed successfully
  • Failed - indicates that the export job has failed
1curl --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/{EXPORT-JOB-ID}"
Give Feedback

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response