Return One Restore Job for One M2 or M5 Cluster

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}

Digest auth

Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role.

Path parameters

clusterName string Required

Human-readable label that identifies the cluster.

Minimum length is 1, maximum length is 64. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
groupId string Required

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

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.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
restoreId string Required

Unique 24-hexadecimal digit string that identifies the restore job to return.

Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.

Query parameters

envelope boolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Default value is false.
pretty boolean

Flag that indicates whether the response body should be in the prettyprint format.

Default value is false.

Responses

200 application/vnd.atlas.2023-01-01+json

OK
Hide response attributes Show response attributes object
- clusterName string
  
  Human-readable label that identifies the source cluster.
  
  Minimum length is 1, maximum length is 64. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
- deliveryType string
  
  Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.
  
  Values are RESTORE or DOWNLOAD.
- expirationDate string(date-time)
  
  Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- id string
  
  Unique 24-hexadecimal digit string that identifies the restore job.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
- links array[object]
  
  List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
  
  Web Linking Specification (RFC 5988)
  
  Hide links attributes Show links attributes object
  
  href string
  
  Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with https://cloud.mongodb.com/api/atlas.
  
  rel string
  
  Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with https://cloud.mongodb.com/api/atlas.
- projectId string
  
  Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
- restoreFinishedDate string(date-time)
  
  Date and time when MongoDB Cloud completed writing this snapshot. MongoDB Cloud changes the status of the restore job to CLOSED. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- restoreScheduledDate string(date-time)
  
  Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- snapshotFinishedDate string(date-time)
  
  Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- snapshotId string Required
  
  Unique 24-hexadecimal digit string that identifies the snapshot to restore.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
- snapshotUrl string
  
  Internet address from which you can download the compressed snapshot files. The resource returns this parameter when "deliveryType" : "DOWNLOAD".
- status string
  
  Phase of the restore workflow for this job at the time this resource made this request.
  
  Values are PENDING, QUEUED, RUNNING, FAILED, or COMPLETED.
- targetDeploymentItemName string Required
  
  Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier M2 or greater.
  
  Minimum length is 1, maximum length is 64. Format should match the following pattern: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
- targetProjectId string
  
  Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.
  
  Minimum length is 24, maximum length is 24. Format should match the following pattern: ^([a-f0-9]{24})$.
400 application/json

Bad Request.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
404 application/json

Not Found.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.
500 application/json

Internal Server Error.
Hide response attributes Show response attributes object
- detail string
  
  Describes the specific conditions or reasons that cause each type of error.
- error integer(int32)
  
  HTTP status code returned with this error.
  
  External documentation
- errorCode string
  
  Application error code returned with this error.
- parameters array[object]
  
  Parameters used to give more information about the error.
- reason string
  
  Application error message returned with this error.

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}

atlas api sharedTierRestoreJobs getSharedClusterBackupRestoreJob --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetSharedClusterBackupRestoreJobApiParams{}
	sdkResp, httpResp, err := client.Shared - TierRestoreJobsApi.
		GetSharedClusterBackupRestoreJobWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-01-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true"

Response examples (200)

{
  "clusterName": "string",
  "deliveryType": "RESTORE",
  "expirationDate": "2025-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "projectId": "32b6e34b3d91647abb20e7b8",
  "restoreFinishedDate": "2025-05-04T09:42:00Z",
  "restoreScheduledDate": "2025-05-04T09:42:00Z",
  "snapshotFinishedDate": "2025-05-04T09:42:00Z",
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "snapshotUrl": "string",
  "status": "PENDING",
  "targetDeploymentItemName": "string",
  "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Response examples (400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

Response examples (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Response examples (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}