MongoDB/createGroupFlexClusterBackupRestoreJob

Online calls unavailable · details below

MongoDBMongoDB Atlas Administration API v2

POST/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs

Manage create Group Flex Cluster Backup Restore Job.

Contract-preserving POST endpoint for create Group Flex Cluster Backup 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
createGroupFlexClusterBackupRestoreJob
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.

name

pathstringrequired

name value in the Atlas Administration API contract.

Request body

FlexBackupRestoreJobCreate20241113required

Content-Type: application/vnd.atlas.2024-11-13+json

Properties: deliveryTypeexpirationDateidinstanceNamelinksprojectIdrestoreFinishedDaterestoreScheduledDatesnapshotFinishedDatesnapshotIdsnapshotUrlstatustargetDeploymentItemNametargetProjectId

Responses

200

FlexBackupRestoreJob20241113application/vnd.atlas.2024-11-13+json

Successful supplier response.

Properties: deliveryTypeexpirationDateidinstanceNamelinksprojectIdrestoreFinishedDaterestoreScheduledDatesnapshotFinishedDatesnapshotIdsnapshotUrlstatustargetDeploymentItemNametargetProjectId

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

409

ApiErrorapplication/json

Supplier response with HTTP status 409.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

429

ApiErrorapplication/json

Supplier response with HTTP status 429.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

500

ApiErrorapplication/json

Supplier response with HTTP status 500.

Properties: badRequestDetaildetailerrorerrorCodeparametersreason

{
  "deliveryType": "RESTORE",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": {
    "href": "https://cloud.mongodb.com/api/atlas",
    "rel": "self"
  },
  "projectId": "32b6e34b3d91647abb20e7b8"
}