Navigation

Cancel One Cloud Provider Snapshot Restore Job

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 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.

All requests to this endpoint must originate from an IP address on the Atlas user’s API whitelist. For complete documentation on configuring API whitelists, see Provide Access to Whitelisted API Operations.

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

Syntax

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

Request Path Parameters

Path Element Description
GROUP-ID The unique identifier of the project for the Atlas cluster.
CLUSTER-NAME The name of the Atlas cluster whose restore job you want to cancel.
JOB-ID The unique identifier of the restore job to cancel. You can only cancel manual download restore jobs. Use the Get One Restore Job Endpoint to confirm the restoration job type.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name Type Description Default
pretty boolean Display 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.

Response

This endpoint does not have response elements.

Example Request

curl --user "{username:apiKey}" --digest --include \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/groups/5b6212af90dc76637950a2c6/clusters/MyCluster/backup/restoreJobs/5b622f7087d9d6039fafe03f"