Get One Cloud Provider Snapshot Restore Job


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 uses HTTP Digest Authentication. Provide your Atlas username and API key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Base URL:


GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs/{JOB-ID}

Request Path Parameters

Path Element Description
GROUP-ID Unique identifier of the project for the Atlas cluster.
CLUSTER-NAME Name of the Atlas cluster from which you want to retrieve the restore job.
JOB-ID Unique identifier of the restore job to retrieve.

Request Query Parameters

The following query parameters are optional:

Query Parameter Type Description Default
pretty boolean Displays response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.


Name Type Description
cancelled boolean Indicates whether the restore job was canceled.
createdAt Date UTC ISO 8601 formatted point in time when Atlas created the restore job.
deliveryType string

Type of restore job to create. Possible values are:

Atlas automatically restores the snapshot with snapshotId to the Atlas cluster with name targetClusterName in the Atlas project with targetGroupId.
Atlas provides a URL to download a .tar.gz of the snapshot with snapshotId. The contents of the tar.gz archive contain the data files for your Atlas cluster. To learn more about manually restoring the downloaded data files, see Download your Snapshot via HTTPS.
deliveryUrl array One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
expired boolean Indicates whether the restore job expired.
expiresAt Date UTC ISO 8601 formatted point in time when the restore job expires.
finishedAt Date UTC ISO 8601 formatted point in time when the restore job completed.
id ObjectId The unique identifier of the restore job.
links array One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
snapshotId string Unique identifier of the source snapshot ID of the restore job.
targetGroupId string Name of the target Atlas project of the restore job. Only visible if deliveryType is automated.
targetClusterName string Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
timestamp string Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

Example Request

curl --user "{username:apiKey}" --digest --include \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET ""

Example Response

    "cancelled": false,
    "deliveryType": "automated",
    "expired": false,
    "expiresAt": "2018-08-02T02:08:48Z",
    "id": "5b622f7087d9d6039fafe03f",
    "links": [
            "href": "",
            "rel": "self"
            "href": "",
            "rel": ""
            "href": "",
            "rel": ""
            "href": "",
            "rel": ""
    "snapshotId": "5b6211ff87d9d663c59d3feg",
    "targetClusterName": "MyOtherCluster",
    "targetGroupId": "5b6212af90dc76637950a2c6",
    "timestamp": "2018-08-01T20:02:07Z"