Return All Restore Jobs For One Serverless Instance¶
On this page
Return all restore jobs of one serverless instance.
Required Roles¶
Your API Key must have one of the following roles to successfully call this resource:
All requests to this endpoint must originate from an IP address in the organization's API access list.
Request¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
GET /groups/{groupId}/serverless/{instanceName}/backup/restoreJobs
Request Path Parameters¶
Name | Type | Necessity | Description |
|---|---|---|---|
groupId | string | Required | Unique 24-hexadecimal digit string that identifies your project. |
instanceName | string | Required | Human-readable label that identifies your serverless instance. |
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¶
Each element in the result array is one serverless instance.
Name | Type | Description |
|---|---|---|
cancelled | boolean | Flag that indicates whether someone canceled the restore job. |
createdAt | string | Timestamp in ISO 8601 date and time format in UTC when Atlas created the restore job. |
deliveryType | string | Type of restore job to create. Atlas returns automated. |
expired | boolean | Flag that indicates whether the restore job expired. |
expiresAt | string | Timestamp in ISO 8601 date and time format in UTC when the restore job expires. |
failed | boolean | Flag that indicates whether someone canceled the restore job. |
finishedAt | string | Timestamp in ISO 8601 date and time format in UTC when the restore job completed. |
id | string | Unique 24-hexadecimal digit string that identifies the restore
job. |
snapshotId | string | Unique 24-hexadecimal digit string that identifies the source of
restore job. |
targetClusterName | string | Human-readable label of the target Atlas cluster or
serverless instance to which the restore job restores the
snapshot. |
targetGroupId | string | Unique 24-hexadecimal digit string that identifies the target
Atlas project of the restore job. |
timestamp | string | Timestamp in ISO 8601 date and time format in UTC when Atlas took the snapshot identified with
snapshotId. |
Example Request¶
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Content-Type: application/json' \ --include \ --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/{groupId}/serverless/{instanceName}/backup/restoreJobs?pretty=true'
Example Response¶
Response Header¶
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
Response Body¶
1 { 2 "links": [ 3 { 4 "rel": "self", 5 "href": "http://cloud.mongodb.com/api/atlas/v1.0/groups/{groupId}/serverless/{instanceName}/backup/restoreJobs?pageNum=1&itemsPerPage=100" 6 } 7 ], 8 "totalCount": 1, 9 "results": [ 10 { 11 "cancelled": false, 12 "deliveryType": "automated", 13 "deliveryUrl": [], 14 "expired": false, 15 "expiresAt": "2021-04-20T00:00:00Z", 16 "failed": false, 17 "id": "{snapshotId}", 18 "snapshotId": "{snapshotId}", 19 "targetClusterName": "{clusterName}", 20 "targetDeploymentItemName": "{deploymentName}", 21 "targetGroupId": "{targetGroupId}", 22 "timestamp": "2020-12-21T00:00:00Z" 23 } 24 ] 25 }