# Return One Legacy Backup Restore Job

**GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}**

Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.

 Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the Cloud Backup documentation.

[Cloud Backup Documentation](https://www.mongodb.com/ko-kr/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule)

## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

#### Path parameters
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) 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.
- **clusterName** (string)
  Human-readable label that identifies the cluster with the snapshot you want to return.
- **jobId** (string)
  Unique 24-hexadecimal digit string that identifies the restore job.

#### 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.
- **pretty** (boolean)
  Flag that indicates whether the response body should be in the prettyprint format.


## Responses
### 200: OK

#### Body Parameters: application/json (object)
- **batchId** (string)
  Unique 24-hexadecimal digit string that identifies the batch to which this restore job belongs. This parameter exists only for a sharded cluster restore.
- **clusterId** (string)
  Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. This parameter returns for restore clusters.
- **clusterName** (string)
  Human-readable label that identifies the cluster containing the snapshots you want to retrieve.
- **created** (string(date-time))
  Date and time when someone requested this restore job. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
- **delivery** (object)
  Method and details that indicate how to deliver the restored snapshot data.
- **deploymentJobId** (string)
  Unique 24-hexadecimal digit string that identifies the an imported deployment job. This parameter exists when restoring from an imported snapshot/clustershot.
- **encryptionEnabled** (boolean)
  Flag that indicates whether someone encrypted the data in the restored snapshot.
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies the project that owns the snapshots.
- **hashes** (array[object])
  List that contains documents mapping each restore file to a hashed checksum. This parameter applies after you download the corresponding **delivery.url**. If `"methodName" : "HTTP"`, this list contains one object that represents the hash of the **.tar.gz** file.
- **id** (string)
  Unique 24-hexadecimal digit string that identifies the restore job.
- **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.
- **masterKeyUUID** (string(uuid))
  Universally Unique Identifier (UUID) that identifies the Key Management Interoperability (KMIP) master key used to encrypt the snapshot data. This parameter applies only when `"encryptionEnabled" : "true"`.
- **snapshotId** (string)
  Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set **snapshotId**, you can't set **oplogInc**, **oplogTs**, **pointInTimeUTCMillis**, or **checkpointId**.
- **statusName** (string)
  Human-readable label that identifies the status of the downloadable file at the time of the request.
- **timestamp** (object)
  BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.

### 400: Bad Request.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **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.

### 401: Unauthorized.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **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.

### 403: Forbidden.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **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: Not Found.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **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: Internal Server Error.

#### Body Parameters: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **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.


[Powered by Bump.sh](https://bump.sh)