MongoDBMongoDB Atlas Administration API v2
POST/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs
Manage create Group Cluster Restore Job.
Contract-preserving POST endpoint for create Group Cluster Restore Job in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.
All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.
Request
- operationId
createGroupClusterRestoreJob- Server
https://cloud.mongodb.com- Authentication
- ServiceAccounts, DigestAuth
Request parameters
envelope
queryboolean
envelope value in the Atlas Administration API contract.
groupId
pathstringrequired
group Id value in the Atlas Administration API contract.
32b6e34b3d91647abb20e7b8
pretty
queryboolean
pretty value in the Atlas Administration API contract.
clusterName
pathstringrequired
cluster Name value in the Atlas Administration API contract.
Request body
BackupRestoreJobrequired
Content-Type: application/vnd.atlas.2023-01-01+json
Properties: batchIdcheckpointIdclusterIdclusterNamecreateddeliverydeploymentJobIdencryptionEnabledgroupIdhashesidlinksmasterKeyUUIDoplogIncoplogTspointInTimeUTCMillissnapshotIdstatusNametimestamp
Responses
200
PaginatedRestoreJobViewapplication/vnd.atlas.2023-01-01+json
Successful supplier response.
Properties: linksresultstotalCount
400
ApiErrorapplication/json
Supplier response with HTTP status 400.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
401
ApiErrorapplication/json
Supplier response with HTTP status 401.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
403
ApiErrorapplication/json
Supplier response with HTTP status 403.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
404
ApiErrorapplication/json
Supplier response with HTTP status 404.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
429
ApiErrorapplication/json
Supplier response with HTTP status 429.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
500
ApiErrorapplication/json
Supplier response with HTTP status 500.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
{
"links": {
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
},
"results": {
"batchId": "32b6e34b3d91647abb20e7b8",
"checkpointId": "32b6e34b3d91647abb20e7b8",
"clusterId": "32b6e34b3d91647abb20e7b8",
"delivery": {
"expirationHours": 0,
"maxDownloads": 0,
"methodName": "CLIENT_PIT_HTTP",
"statusName": "NOT_STARTED",
"targetClusterId": "32b6e34b3d91647abb20e7b8"
},
"encryptionEnabled": false
},
"totalCount": 0
}