openapi: 3.0.1 info: description: "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API supports OAuth2 Service Accounts and HTTP Digest-based API keys. Service accounts are the recommended authentication method and API keys are considered a legacy option.\n\nTo authenticate with a Service Account, first exchange its client ID and secret for an access token using the OAuth 2.0 Client Credentials flow. Atlas provides a token endpoint at `POST https://cloud.mongodb.com/api/oauth/token`, which returns a Bearer token that is reusable and valid for 1 hour (3600 seconds).\n\nFor example, to [return a list of your organizations](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-listorgs) with [cURL](https://en.wikipedia.org/wiki/CURL), first generate an access token and then use that token to call the same Atlas Administration API endpoint shown in the current example:\n\n```\nACCESS_TOKEN=$(curl -fsS --request POST https://cloud.mongodb.com/api/oauth/token \\\n --header \"Authorization: Basic $(printf '%s' \"${CLIENT_ID}:${CLIENT_SECRET}\" | base64 | tr -d '\\n')\" \\\n --header \"Content-Type: application/x-www-form-urlencoded\" \\\n --header \"Accept: application/json\" \\\n --data \"grant_type=client_credentials\" | jq -r '.access_token')\n\ncurl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"\n```\n\nIf your organization requires an IP access list for the Atlas Administration API, the token can be created from any IP address, but the API call that uses the token must originate from an allowed IP.\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/) (requires a Postman account)." license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration Access Tracking Cloud Backups API version: '2.0' x-xgen-sha: 3d70e065843c008b9871ea7836c98c9de6f202f9 servers: - url: https://cloud.mongodb.com security: - ServiceAccounts: [] - DigestAuth: [] tags: - description: Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups. name: Cloud Backups paths: /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: description: 'Returns all Export Buckets associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' operationId: listGroupBackupExportBuckets parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' responses: '200': content: application/vnd.atlas.2024-05-30+json: schema: $ref: '#/components/schemas/PaginatedBackupSnapshotExportBucketsView' x-xgen-version: '2024-05-30' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Snapshot Export Buckets tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups listExportBuckets --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupBackupExportBucketsApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tListGroupBackupExportBucketsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupBackupExportBuckets x-xgen-operation-id-override: listExportBuckets post: description: 'Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: createGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' requestBody: content: application/vnd.atlas.2024-05-30+json: examples: AWS: description: AWS value: bucketName: export-bucket cloudProvider: AWS iamRoleId: 668c5f0ed436263134491592 requirePrivateNetworking: false Azure: description: Azure value: bucketName: examplecontainer cloudProvider: AZURE roleId: 668c5f0ed436263134491592 serviceUrl: https://examplestorageaccount.blob.core.windows.net/examplecontainer GCP: description: GCP value: bucketName: export-bucket cloudProvider: GCP roleId: 668c5f0ed436263134491592 schema: $ref: '#/components/schemas/DiskBackupSnapshotExportBucketRequest' x-xgen-version: '2024-05-30' description: Specifies the role and AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket that the Export Bucket should reference. required: true responses: '200': content: application/vnd.atlas.2024-05-30+json: examples: AWS: description: AWS value: _id: 32b6e34b3d91647abb20e7b8 bucketName: export-bucket cloudProvider: AWS iamRoleId: 668c5f0ed436263134491592 links: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 requirePrivateNetworking: true Azure: description: Azure value: _id: 32b6e34b3d91647abb20e7b8 bucketName: examplecontainer cloudProvider: AZURE links: - href: https://cloud.mongodb.com/api/atlas rel: self roleId: 668c5f0ed436263134491592 serviceUrl: https://examplestorageaccount.blob.core.windows.net/examplecontainer tenantId: 4297fc77-1592-4de8-a6d5-a8c32401df87 GCP: description: GCP value: _id: 32b6e34b3d91647abb20e7b8 bucketName: export-bucket cloudProvider: GCP links: - href: https://cloud.mongodb.com/api/atlas rel: self roleId: 668c5f0ed436263134491592 schema: $ref: '#/components/schemas/DiskBackupSnapshotExportBucketResponse' x-xgen-version: '2024-05-30' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Create One Snapshot Export Bucket tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups createExportBucket --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupBackupExportBucketApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupBackupExportBucketWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupBackupExportBucket x-xgen-operation-id-override: createExportBucket /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: description: Deletes an Export Bucket. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: deleteGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Unique 24-hexadecimal character string that identifies the Export Bucket. in: path name: exportBucketId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string responses: '204': content: application/vnd.atlas.2023-01-01+json: x-xgen-version: '2023-01-01' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Delete One Snapshot Export Bucket tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups deleteExportBucket --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupBackupExportBucketApiParams{}\n\thttpResp, err := client.CloudBackupsApi.\n\t\tDeleteGroupBackupExportBucketWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupBackupExportBucket x-xgen-operation-id-override: deleteExportBucket get: description: 'Returns one Export Bucket associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' operationId: getGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Unique 24-hexadecimal character string that identifies the Export Bucket. in: path name: exportBucketId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2024-05-30+json: examples: AWS: description: AWS value: _id: 32b6e34b3d91647abb20e7b8 bucketName: export-bucket cloudProvider: AWS iamRoleId: 668c5f0ed436263134491592 links: - href: https://cloud.mongodb.com/api/atlas rel: self region: us-east-1 requirePrivateNetworking: true Azure: description: Azure value: _id: 32b6e34b3d91647abb20e7b8 bucketName: examplecontainer cloudProvider: AZURE links: - href: https://cloud.mongodb.com/api/atlas rel: self roleId: 668c5f0ed436263134491592 serviceUrl: https://examplestorageaccount.blob.core.windows.net/examplecontainer tenantId: 4297fc77-1592-4de8-a6d5-a8c32401df87 GCP: description: GCP value: _id: 32b6e34b3d91647abb20e7b8 bucketName: export-bucket cloudProvider: GCP links: - href: https://cloud.mongodb.com/api/atlas rel: self roleId: 668c5f0ed436263134491592 schema: $ref: '#/components/schemas/DiskBackupSnapshotExportBucketResponse' x-xgen-version: '2024-05-30' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Snapshot Export Bucket tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getExportBucket --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupBackupExportBucketApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupBackupExportBucketWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupExportBucket x-xgen-operation-id-override: getExportBucket patch: description: Updates the private networking settings for one snapshot export bucket in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: updateGroupBackupExportBucket parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Unique 24-hexadecimal character string that identifies the snapshot export bucket. in: path name: exportBucketId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string requestBody: content: application/vnd.atlas.2024-05-30+json: schema: $ref: '#/components/schemas/UpdateRequirePrivateNetworkingRequestView' x-xgen-version: '2024-05-30' description: Updates the private networking requirement for the snapshot export bucket. required: true responses: '200': content: application/vnd.atlas.2024-05-30+json: schema: $ref: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' x-xgen-version: '2024-05-30' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Update One Export Bucket Private Networking Settings tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups updateBackupExportBucket --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupBackupExportBucketApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tUpdateGroupBackupExportBucketWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\" \\\n -d '{ }'" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupBackupExportBucket x-xgen-operation-id-override: updateBackupExportBucket /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for object storage backup operations. operationId: listGroupBackupPrivateEndpoints parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path name: cloudProvider required: true schema: enum: - AWS type: string responses: '200': content: application/vnd.atlas.2024-11-13+json: schema: $ref: '#/components/schemas/PaginatedApiAtlasObjectStoragePrivateEndpointResponseView' x-xgen-version: '2024-11-13' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return Object Storage Private Endpoints for Cloud Backups for One Cloud Provider in One Project tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups listBackupPrivateEndpoints --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupBackupPrivateEndpointsApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tListGroupBackupPrivateEndpointsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints?pretty=true\"" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupBackupPrivateEndpoints x-xgen-operation-id-override: listBackupPrivateEndpoints post: description: Creates a private endpoint in the specified region for secure, private connectivity between Atlas and cloud provider object storage services for backup operations. operationId: createGroupBackupPrivateEndpoint parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/envelope' - description: Human-readable label that identifies the cloud provider for the private endpoint to create. in: path name: cloudProvider required: true schema: enum: - AWS type: string requestBody: content: application/vnd.atlas.2024-11-13+json: schema: $ref: '#/components/schemas/ObjectStoragePrivateEndpointRequest' description: Creates a private endpoint in the specified region for object storage backup operations. required: true responses: '201': content: application/vnd.atlas.2024-11-13+json: schema: $ref: '#/components/schemas/ObjectStoragePrivateEndpointResponse' x-xgen-version: '2024-11-13' description: Created headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Create One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups createBackupPrivateEndpoint --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupBackupPrivateEndpointApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupBackupPrivateEndpointWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupBackupPrivateEndpoint x-xgen-operation-id-override: createBackupPrivateEndpoint /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for object storage backup operations. operationId: deleteGroupBackupPrivateEndpoint parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/envelope' - description: Human-readable label that identifies the cloud provider of the private endpoint to delete. in: path name: cloudProvider required: true schema: enum: - AWS type: string - description: Unique 24-hexadecimal digit string that identifies the private endpoint to delete. in: path name: endpointId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '204': content: application/vnd.atlas.2024-11-13+json: x-xgen-version: '2024-11-13' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Delete One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider from One Project tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups deleteBackupPrivateEndpoint --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupBackupPrivateEndpointApiParams{}\n\thttpResp, err := client.CloudBackupsApi.\n\t\tDeleteGroupBackupPrivateEndpointWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}\"" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupBackupPrivateEndpoint x-xgen-operation-id-override: deleteBackupPrivateEndpoint get: description: Returns one private endpoint, identified by its ID, for object storage backup operations. operationId: getGroupBackupPrivateEndpoint parameters: - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/envelope' - description: Human-readable label that identifies the cloud provider of the private endpoint. in: path name: cloudProvider required: true schema: enum: - AWS type: string - description: Unique 24-hexadecimal digit string that identifies the private endpoint. in: path name: endpointId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2024-11-13+json: schema: $ref: '#/components/schemas/ObjectStoragePrivateEndpointResponse' x-xgen-version: '2024-11-13' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getBackupPrivateEndpoint --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupBackupPrivateEndpointApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupBackupPrivateEndpointWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupPrivateEndpoint x-xgen-operation-id-override: getBackupPrivateEndpoint /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: delete: description: Disables the Backup Compliance Policy settings with the specified project. As a prerequisite, a support ticket needs to be file first, instructions in https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/. To use this resource, the requesting Service Account or API Key must have the Project Owner role. operationId: disableGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' responses: '204': content: application/vnd.atlas.2024-11-13+json: x-xgen-version: '2024-11-13' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Disable Backup Compliance Policy Settings tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups disableCompliancePolicy --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DisableGroupBackupCompliancePolicyApiParams{}\n\thttpResp, err := client.CloudBackupsApi.\n\t\tDisableGroupBackupCompliancePolicyWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\"" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableGroupBackupCompliancePolicy x-xgen-method-verb-override: customMethod: 'True' verb: disable x-xgen-operation-id-override: disableCompliancePolicy get: description: 'Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: getGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' responses: '200': content: application/vnd.atlas.2023-10-01+json: schema: $ref: '#/components/schemas/DataProtectionSettings20231001' x-xgen-version: '2023-10-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return Backup Compliance Policy Settings tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getCompliancePolicy --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupBackupCompliancePolicyApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupBackupCompliancePolicyWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupBackupCompliancePolicy x-xgen-operation-id-override: getCompliancePolicy put: description: 'Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateGroupBackupCompliancePolicy parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Flag that indicates whether to overwrite non complying backup policies with the new data protection settings or not. in: query name: overwriteBackupPolicies schema: default: true type: boolean - $ref: '#/components/parameters/pretty' requestBody: content: application/vnd.atlas.2023-10-01+json: schema: $ref: '#/components/schemas/DataProtectionSettings20231001' x-xgen-version: '2023-10-01' description: The new Backup Compliance Policy settings. required: true responses: '200': content: application/vnd.atlas.2023-10-01+json: schema: $ref: '#/components/schemas/DataProtectionSettings20231001' x-xgen-version: '2023-10-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Update Backup Compliance Policy Settings tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups updateCompliancePolicy --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupBackupCompliancePolicyApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tUpdateGroupBackupCompliancePolicyWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" x-rolesRequirements: - Project Owner x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupBackupCompliancePolicy x-xgen-operation-id-override: updateCompliancePolicy /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. operationId: listGroupClusterBackupExports parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Snapshot Export Jobs tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups listBackupExports --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupExportsApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tListGroupClusterBackupExportsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupExports x-xgen-operation-id-override: listBackupExports post: description: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting Service Account or API Key must have the Project Backup Export Operator role. operationId: createGroupClusterBackupExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupExportJobRequest' description: Information about the Cloud Backup Snapshot Export Job to create. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupExportJob' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Create One Snapshot Export Job tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups createBackupExport --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterBackupExportApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupClusterBackupExportWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" x-rolesRequirements: - Project Backup Export Operator x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupClusterBackupExport x-xgen-operation-id-override: createBackupExport /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. operationId: getGroupClusterBackupExport parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal character string that identifies the Export Job. in: path name: exportId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupExportJob' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Snapshot Export Job tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getBackupExport --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupExportApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupExportWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupExport x-xgen-operation-id-override: getBackupExport /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: listGroupClusterBackupRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster with the restore jobs you want to return. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedCloudBackupRestoreJobView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Restore Jobs for One Cluster tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups listBackupRestoreJobs --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupRestoreJobsApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tListGroupClusterBackupRestoreJobsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupRestoreJobs x-xgen-operation-id-override: listBackupRestoreJobs post: description: "Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of `queued` or `inProgress` exists, before taking another snapshot, wait until Atlas completes processing the previously taken on-demand snapshot.\n\n To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role, Project Backup Export Operator role, or Project Backup Recovery Operator role." operationId: createGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupSnapshotRestoreJob' description: Restores one snapshot of one cluster from the specified project. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupSnapshotRestoreJob' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Create One Restore Job of One Cluster tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups createBackupRestoreJob --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupClusterBackupRestoreJobApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupClusterBackupRestoreJobWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" x-rolesRequirements: - Project Backup Export Operator - Project Backup Recovery Operator x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupClusterBackupRestoreJob x-xgen-operation-id-override: createBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role, Project Backup Export Operator role, or Project Backup Recovery Operator role. operationId: cancelGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path name: restoreJobId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '204': content: application/vnd.atlas.2023-01-01+json: x-xgen-version: '2023-01-01' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '405': $ref: '#/components/responses/methodNotAllowed' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Cancel One Restore Job for One Cluster tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups cancelBackupRestoreJob --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CancelGroupClusterBackupRestoreJobApiParams{}\n\thttpResp, err := client.CloudBackupsApi.\n\t\tCancelGroupClusterBackupRestoreJobWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" x-rolesRequirements: - Project Backup Export Operator - Project Backup Recovery Operator x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelGroupClusterBackupRestoreJob x-xgen-method-verb-override: customMethod: 'True' verb: cancel x-xgen-operation-id-override: cancelBackupRestoreJob get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: getGroupClusterBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster with the restore jobs you want to return. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path name: restoreJobId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupSnapshotRestoreJob' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Restore Job for One Cluster tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getBackupRestoreJob --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupRestoreJobApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupRestoreJobWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupRestoreJob x-xgen-operation-id-override: getBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: description: 'Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. Deprecated versions: v2-{2023-01-01}' operationId: deleteGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/DiskBackupSnapshotSchedule20240805' x-xgen-version: '2024-08-05' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Remove All Cloud Backup Schedules tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups deleteClusterBackupSchedule --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterBackupScheduleApiParams{}\n\thttpResp, err := client.CloudBackupsApi.\n\t\tDeleteGroupClusterBackupScheduleWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSchedule x-xgen-operation-id-override: deleteClusterBackupSchedule get: description: 'Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' operationId: getGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/DiskBackupSnapshotSchedule20240805' x-xgen-version: '2024-08-05' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Cloud Backup Schedule tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getBackupSchedule --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupScheduleApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupScheduleWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSchedule x-xgen-method-verb-override: customMethod: 'False' verb: get x-xgen-operation-id-override: getBackupSchedule patch: description: 'Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateGroupClusterBackupSchedule parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string requestBody: content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/DiskBackupSnapshotSchedule20240805' description: 'Updates the cloud backup schedule for one cluster within the specified project. **Note**: In the request body, provide only the fields that you want to update.' required: true responses: '200': content: application/vnd.atlas.2024-08-05+json: schema: $ref: '#/components/schemas/DiskBackupSnapshotSchedule20240805' x-xgen-version: '2024-08-05' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups updateBackupSchedule --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterBackupScheduleApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tUpdateGroupClusterBackupScheduleWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupClusterBackupSchedule x-xgen-operation-id-override: updateBackupSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. operationId: listGroupClusterBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Desired point in time, expressed as the number of seconds that have elapsed since the UNIX epoch. If specified, returns the closest snapshot created before that point in time. Mutually exclusive with `oplogTs` and `oplogInc`. in: query name: pointInTimeUtcSeconds schema: format: int64 type: integer - description: Oplog timestamp that represents the desired point in time. This is the first part of an Oplog timestamp. Must be used with `oplogInc`. Mutually exclusive with `pointInTimeUtcSeconds`. in: query name: oplogTs schema: format: int64 type: integer - description: Oplog operation number that represents the desired point in time. This is the second part of an Oplog timestamp. Must be used with `oplogTs`. Mutually exclusive with `pointInTimeUtcSeconds`. in: query name: oplogInc schema: format: int64 type: integer responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedCloudBackupReplicaSetView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Replica Set Cloud Backups tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups listBackupSnapshots --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupSnapshotsApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tListGroupClusterBackupSnapshotsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupSnapshots x-xgen-operation-id-override: listBackupSnapshots post: description: "Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of `queued` or `inProgress` exists, before taking another snapshot, wait until Atlas completes processing the previously taken on-demand snapshot.\n\n To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role or Project Backup Creator role." operationId: takeGroupClusterBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupOnDemandSnapshotRequest' description: Takes one on-demand snapshot. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupSnapshot' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Take One On-Demand Snapshot tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups takeSnapshots --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.TakeGroupClusterBackupSnapshotsApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tTakeGroupClusterBackupSnapshotsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" x-rolesRequirements: - Project Backup Creator x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeGroupClusterBackupSnapshots x-xgen-method-verb-override: customMethod: 'True' verb: take x-xgen-operation-id-override: takeSnapshots /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: deleteGroupClusterBackupSnapshotShardedCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path name: snapshotId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '204': content: application/vnd.atlas.2023-01-01+json: x-xgen-version: '2023-01-01' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Remove One Sharded Cluster Cloud Backup tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups deleteBackupShardedCluster --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterBackupSnapshotShardedClusterApiParams{}\n\thttpResp, err := client.CloudBackupsApi.\n\t\tDeleteGroupClusterBackupSnapshotShardedClusterWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSnapshotShardedCluster x-xgen-operation-id-override: deleteBackupShardedCluster get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. operationId: getGroupClusterBackupSnapshotShardedCluster parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path name: snapshotId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupShardedClusterSnapshot' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Sharded Cluster Cloud Backup tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getBackupShardedCluster --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupSnapshotShardedClusterApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupSnapshotShardedClusterWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSnapshotShardedCluster x-xgen-operation-id-override: getBackupShardedCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. operationId: listGroupClusterBackupSnapshotShardedClusters parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Sharded Cluster Cloud Backups tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups listBackupShardedClusters --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupClusterBackupSnapshotShardedClustersApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tListGroupClusterBackupSnapshotShardedClustersWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupClusterBackupSnapshotShardedClusters x-xgen-operation-id-override: listBackupShardedClusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: deleteGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path name: snapshotId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '204': content: application/vnd.atlas.2023-01-01+json: x-xgen-version: '2023-01-01' description: This endpoint does not return a response body. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Remove One Replica Set Cloud Backup tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups deleteClusterBackupSnapshot --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.DeleteGroupClusterBackupSnapshotApiParams{}\n\thttpResp, err := client.CloudBackupsApi.\n\t\tDeleteGroupClusterBackupSnapshotWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteGroupClusterBackupSnapshot x-xgen-operation-id-override: deleteClusterBackupSnapshot get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. operationId: getGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path name: snapshotId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupReplicaSet' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Replica Set Cloud Backup tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getClusterBackupSnapshot --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupClusterBackupSnapshotApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupClusterBackupSnapshotWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" x-rolesRequirements: - Project Read Only x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupClusterBackupSnapshot x-xgen-operation-id-override: getClusterBackupSnapshot patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project, the requesting Service Account or API Key must have the Project Backup Manager role. operationId: updateGroupClusterBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the cluster. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path name: snapshotId required: true schema: pattern: ^([a-f0-9]{24})$ type: string requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/BackupSnapshotRetention' description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/DiskBackupReplicaSet' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Update Expiration Date for One Cloud Backup tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups updateBackupSnapshot --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.UpdateGroupClusterBackupSnapshotApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tUpdateGroupClusterBackupSnapshotWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" x-rolesRequirements: - Project Backup Manager x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateGroupClusterBackupSnapshot x-xgen-operation-id-override: updateBackupSnapshot /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: deprecated: true description: 'Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the List Flex Backup Restore Jobs endpoint instead.' externalDocs: description: List Flex Backup Restore Jobs url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs operationId: listGroupServerlessBackupRestoreJobs parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the serverless instance. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Restore Jobs for One Serverless Instance tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups listServerlessRestoreJobs --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupServerlessBackupRestoreJobsApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tListGroupServerlessBackupRestoreJobsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" x-rolesRequirements: - Project Owner x-sunset: '2026-01-22' x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupServerlessBackupRestoreJobs x-xgen-operation-id-override: listServerlessRestoreJobs post: deprecated: true description: 'Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the Create Flex Backup Restore Job endpoint instead.' externalDocs: description: Create Flex Backup Restore Job url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob operationId: createGroupServerlessBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the serverless instance whose snapshot you want to restore. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string requestBody: content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/ServerlessBackupRestoreJob' description: Restores one snapshot of one serverless instance from the specified project. required: true responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/ServerlessBackupRestoreJob' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '409': $ref: '#/components/responses/conflict' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Create One Restore Job for One Serverless Instance tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups createServerlessRestoreJob --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.CreateGroupServerlessBackupRestoreJobApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tCreateGroupServerlessBackupRestoreJobWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" x-rolesRequirements: - Project Owner x-sunset: '2026-01-22' x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createGroupServerlessBackupRestoreJob x-xgen-operation-id-override: createServerlessRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: deprecated: true description: 'Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the Get Flex Backup Restore Job endpoint instead.' externalDocs: description: Get Flex Backup Restore Job url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob operationId: getGroupServerlessBackupRestoreJob parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - description: Human-readable label that identifies the serverless instance. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path name: restoreJobId required: true schema: pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/ServerlessBackupRestoreJob' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Restore Job for One Serverless Instance tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getServerlessRestoreJob --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupServerlessBackupRestoreJobApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupServerlessBackupRestoreJobWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" x-rolesRequirements: - Project Owner x-sunset: '2026-01-22' x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupServerlessBackupRestoreJob x-xgen-operation-id-override: getServerlessRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: deprecated: true description: 'Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This API can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) endpoint or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the List Flex Backups endpoint instead.' externalDocs: description: List Flex Backups url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups operationId: listGroupServerlessBackupSnapshots parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/pretty' - $ref: '#/components/parameters/includeCount' - $ref: '#/components/parameters/itemsPerPage' - $ref: '#/components/parameters/pageNum' - description: Human-readable label that identifies the serverless instance. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return All Snapshots of One Serverless Instance tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups listServerlessBackupSnapshots --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.ListGroupServerlessBackupSnapshotsApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tListGroupServerlessBackupSnapshotsWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" x-rolesRequirements: - Project Read Only x-sunset: '2026-01-22' x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listGroupServerlessBackupSnapshots x-xgen-operation-id-override: listServerlessBackupSnapshots /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: deprecated: true description: 'Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. This endpoint can also be used on Flex clusters that were created with the [Create Serverless Instance](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance) API or Flex clusters that were migrated from Serverless instances. This endpoint will be sunset on January 22, 2026. Please use the Get Flex Backup endpoint instead.' externalDocs: description: Get Flex Backup url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup operationId: getGroupServerlessBackupSnapshot parameters: - $ref: '#/components/parameters/envelope' - $ref: '#/components/parameters/groupId' - description: Human-readable label that identifies the serverless instance. in: path name: clusterName required: true schema: pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path name: snapshotId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string responses: '200': content: application/vnd.atlas.2023-01-01+json: schema: $ref: '#/components/schemas/ServerlessBackupSnapshot' x-xgen-version: '2023-01-01' description: OK headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' '400': $ref: '#/components/responses/badRequest' '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/notFound' '429': $ref: '#/components/responses/tooManyRequests' '500': $ref: '#/components/responses/internalServerError' summary: Return One Snapshot of One Serverless Instance tags: - Cloud Backups x-codeSamples: - lang: cURL label: Atlas CLI source: atlas api cloudBackups getServerlessBackupSnapshot --help - lang: go label: Go source: "import (\n\t\"os\"\n\t\"context\"\n\t\"log\"\n\tsdk \"go.mongodb.org/atlas-sdk/v20250312001/admin\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n\tclient, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))\n\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n\tparams = &sdk.GetGroupServerlessBackupSnapshotApiParams{}\n\tsdkResp, httpResp, err := client.CloudBackupsApi.\n\t\tGetGroupServerlessBackupSnapshotWithParams(ctx, params).\n\t\tExecute()\n}\n" - lang: cURL label: curl (Service Accounts) source: "curl --include --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" - lang: cURL label: curl (Digest) source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest --include \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" x-rolesRequirements: - Project Read Only x-sunset: '2026-01-22' x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getGroupServerlessBackupSnapshot x-xgen-operation-id-override: getServerlessBackupSnapshot components: schemas: ExportStatus: description: State of the Export Job. properties: exportedCollections: description: Count of collections whose documents were exported to the Export Bucket. format: int32 readOnly: true type: integer totalCollections: description: Total count of collections whose documents will be exported to the Export Bucket. format: int32 readOnly: true type: integer type: object DiskBackupExportJobRequest: properties: customData: description: Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes. items: $ref: '#/components/schemas/BackupLabel' type: array exportBucketId: description: Unique 24-hexadecimal character string that identifies the Export Bucket. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string writeOnly: true links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array snapshotId: description: Unique 24-hexadecimal character string that identifies the Cloud Backup Snapshot to export. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string writeOnly: true required: - exportBucketId - snapshotId type: object PaginatedCloudBackupRestoreJobView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/DiskBackupSnapshotRestoreJob' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object PaginatedCloudBackupShardedClusterSnapshotView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/DiskBackupShardedClusterSnapshot' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object Link: properties: href: description: 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`. example: https://cloud.mongodb.com/api/atlas type: string rel: description: 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`. example: self type: string type: object AutoExportPolicyView: description: Policy for automatically exporting Cloud Backup Snapshots. properties: exportBucketId: description: Unique 24-hexadecimal character string that identifies the Export Bucket. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string frequencyType: description: Human-readable label that indicates the rate at which the export policy item occurs. enum: - monthly - yearly type: string title: export type: object ServerlessBackupSnapshot: properties: createdAt: description: Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string expiresAt: description: Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string frequencyType: description: Human-readable label that identifies how often this snapshot triggers. enum: - hourly - daily - weekly - monthly readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array mongodVersion: description: Version of the MongoDB host that this snapshot backs up. pattern: ([\d]+\.[\d]+\.[\d]+) readOnly: true type: string serverlessInstanceName: description: Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ readOnly: true type: string snapshotType: description: Human-readable label that identifies when this snapshot triggers. enum: - onDemand - scheduled readOnly: true type: string status: description: Human-readable label that indicates the stage of the backup process for this snapshot. enum: - queued - inProgress - completed - failed readOnly: true type: string storageSizeBytes: description: Number of bytes taken to store the backup snapshot. format: int64 readOnly: true type: integer type: object DiskBackupApiPolicyItem: description: Specifications for one policy. properties: frequencyInterval: description: "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings." enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 40 format: int32 type: integer frequencyType: description: Human-readable label that identifies the frequency type associated with the backup policy. enum: - daily - hourly - weekly - monthly - yearly - ondemand type: string id: description: Unique 24-hexadecimal digit string that identifies this backup policy item. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string retentionUnit: description: Unit of time in which MongoDB Cloud measures Snapshot retention. enum: - days - weeks - months - years type: string retentionValue: description: 'Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. For example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item.' format: int32 type: integer required: - frequencyInterval - frequencyType - retentionUnit - retentionValue type: object DiskBackupSnapshotExportBucketRequest: description: Disk backup snapshot Export Bucket Request. discriminator: mapping: AWS: '#/components/schemas/DiskBackupSnapshotAWSExportBucketRequest' AZURE: '#/components/schemas/DiskBackupSnapshotAzureExportBucketRequest' GCP: '#/components/schemas/DiskBackupSnapshotGCPExportBucketRequest' propertyName: cloudProvider properties: cloudProvider: description: Human-readable label that identifies the cloud provider. enum: - AWS - AZURE - GCP type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array required: - cloudProvider type: object PaginatedApiAtlasServerlessBackupRestoreJobView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/ServerlessBackupRestoreJob' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object ApiError: properties: badRequestDetail: $ref: '#/components/schemas/BadRequestDetail' detail: description: Describes the specific conditions or reasons that cause each type of error. type: string error: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status format: int32 readOnly: true type: integer errorCode: description: Application error code returned with this error. readOnly: true type: string parameters: description: Parameters used to give more information about the error. items: type: object readOnly: true type: array reason: description: Application error message returned with this error. readOnly: true type: string required: - error - errorCode type: object ObjectStoragePrivateEndpointResponse: properties: cloudProvider: description: Human-readable label that identifies the cloud provider. enum: - AWS type: string errorMessage: description: Error message for failures associated with the Object Storage private endpoint. readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the Private Endpoint Service. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string privateEndpointConnectionName: description: Connection name of the Private Endpoint. readOnly: true type: string regionName: description: Cloud provider region in which the Object Storage private endpoint is located. oneOf: - description: 'Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.' enum: - US_GOV_WEST_1 - US_GOV_EAST_1 - US_EAST_1 - US_EAST_2 - US_WEST_1 - US_WEST_2 - CA_CENTRAL_1 - EU_NORTH_1 - EU_WEST_1 - EU_WEST_2 - EU_WEST_3 - EU_CENTRAL_1 - AP_EAST_1 - AP_NORTHEAST_1 - AP_NORTHEAST_2 - AP_NORTHEAST_3 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 - AP_SOUTHEAST_3 - AP_SOUTH_1 - SA_EAST_1 - CN_NORTH_1 - CN_NORTHWEST_1 - ME_SOUTH_1 - AF_SOUTH_1 - EU_SOUTH_1 - GLOBAL type: string type: object status: description: State of the Object Storage private endpoint. enum: - INITIATING - PENDING_ACCEPTANCE - ACTIVE - FAILED - PENDING_RECREATION - DELETING readOnly: true type: string type: object DiskBackupTimeBasedCopyPolicyItem: allOf: - $ref: '#/components/schemas/DiskBackupCopyPolicyItem' - properties: retentionUnit: description: Unit of time in which MongoDB Cloud measures snapshot copy retention. enum: - days - weeks - months - years type: string retentionValue: description: Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot copy. format: int32 type: integer type: object description: Specifications for one time-based copy policy item. required: - frequencyType - retentionUnit - retentionValue type: object DiskBackupOnDemandSnapshotRequest: properties: description: description: 'Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status" : "onDemand"`.' type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array retentionInDays: description: Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least **1**. format: int32 minimum: 1 type: integer type: object ExtraRetentionSetting: description: Extra retention setting item in the desired backup policy. properties: frequencyType: description: The frequency type for the extra retention settings for the cluster. enum: - HOURLY - DAILY - WEEKLY - MONTHLY - YEARLY - ON_DEMAND type: string retentionDays: description: The number of extra retention days for the cluster. format: int32 type: integer type: object ApiPrivateDownloadDeliveryUrl: description: One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint. properties: deliveryUrl: description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. type: string endpointId: description: Unique 22-character alphanumeric string that identifies the private endpoint. example: vpce-3bf78b0ddee411ba1 pattern: ^vpce-[0-9a-f]{17}$ type: string type: object DiskBackupSnapshotSchedule20240805: properties: autoCopySettingsEnabled: description: Flag that indicates whether the copy settings are automatically managed by MongoDB Cloud and sync to the cluster topology. type: boolean autoExportEnabled: description: Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket. type: boolean clusterId: description: Unique 24-hexadecimal digit string that identifies the cluster with the Snapshot you want to return. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string clusterName: description: Human-readable label that identifies the cluster with the Snapshot you want to return. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ readOnly: true type: string copyPolicyItemsEnabled: description: Flag that indicates whether copy settings use `copyPolicyItems` instead of `frequencies`. When true, requests must supply `copyPolicyItems` and responses return `copyPolicyItems` only. When false or omitted, requests must supply `frequencies` and responses return `frequencies` only. type: boolean copySettings: description: List that contains a document for each copy setting item in the desired backup policy. items: $ref: '#/components/schemas/DiskBackupCopySetting20240805' type: array deleteCopiedBackups: description: List that contains a document for each deleted copy setting whose backup copies you want to delete. items: $ref: '#/components/schemas/DeleteCopiedBackups20240805' type: array writeOnly: true deleteCopySnapshots: description: Flag that indicates whether to delete Snapshot copies that MongoDB Cloud took previously when their associated `copyPolicyItems` are removed from a `copySetting`. This option requires `copyPolicyItemsEnabled` to be true. type: boolean writeOnly: true deleteSnapshots: description: Flag that indicates whether to delete Snapshots that MongoDB Cloud took previously when deleting the associated backup policy. type: boolean writeOnly: true export: $ref: '#/components/schemas/AutoExportPolicyView' extraRetentionSettings: description: List that contains a document for each extra retention setting item in the desired backup policy. items: $ref: '#/components/schemas/ExtraRetentionSetting' type: array links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array nextSnapshot: description: Date and time when MongoDB Cloud takes the next Snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string policies: description: Rules set for this backup schedule. items: $ref: '#/components/schemas/AdvancedDiskBackupSnapshotSchedulePolicy' maxItems: 1 type: array referenceHourOfDay: description: Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the Snapshot. format: int32 type: integer referenceMinuteOfHour: description: Minute of the `referenceHourOfDay` that represents when MongoDB Cloud takes the Snapshot. format: int32 type: integer restoreWindowDays: description: Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous Cloud Backups only. format: int32 type: integer updateCopySnapshots: description: Flag that indicates whether to apply the retention changes for updated copy policy items to Snapshot copies that MongoDB Cloud took previously. type: boolean writeOnly: true updateSnapshots: description: Flag that indicates whether to apply the retention changes in the updated backup policy to Snapshots that MongoDB Cloud took previously. type: boolean writeOnly: true useOrgAndGroupNamesInExportPrefix: description: Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your Export Bucket. type: boolean required: - policies type: object ObjectStoragePrivateEndpointRequest: properties: cloudProvider: description: Human-readable label that identifies the cloud provider. enum: - AWS type: string regionName: description: Cloud provider region in which the Object Storage private endpoint is located. oneOf: - description: 'Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud assigns the VPC a CIDR block. To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.' enum: - US_GOV_WEST_1 - US_GOV_EAST_1 - US_EAST_1 - US_EAST_2 - US_WEST_1 - US_WEST_2 - CA_CENTRAL_1 - EU_NORTH_1 - EU_WEST_1 - EU_WEST_2 - EU_WEST_3 - EU_CENTRAL_1 - AP_EAST_1 - AP_NORTHEAST_1 - AP_NORTHEAST_2 - AP_NORTHEAST_3 - AP_SOUTHEAST_1 - AP_SOUTHEAST_2 - AP_SOUTHEAST_3 - AP_SOUTH_1 - SA_EAST_1 - CN_NORTH_1 - CN_NORTHWEST_1 - ME_SOUTH_1 - AF_SOUTH_1 - EU_SOUTH_1 - GLOBAL type: string type: object type: object BackupComplianceOnDemandPolicyItem: description: Specifications for on-demand policy. properties: frequencyInterval: description: Number that indicates the frequency interval for a set of snapshots. MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings. enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 40 format: int32 type: integer frequencyType: description: Human-readable label that identifies the frequency type associated with the backup policy. enum: - ondemand type: string id: description: Unique 24-hexadecimal digit string that identifies this backup policy item. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string retentionUnit: description: Unit of time in which MongoDB Cloud measures snapshot retention. enum: - days - weeks - months - years type: string retentionValue: description: 'Duration in days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. For example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item.' format: int32 type: integer required: - frequencyInterval - frequencyType - retentionUnit - retentionValue type: object DiskBackupSnapshotExportBucketResponse: description: Disk backup snapshot Export Bucket. discriminator: mapping: AWS: '#/components/schemas/DiskBackupSnapshotAWSExportBucketResponse' AZURE: '#/components/schemas/DiskBackupSnapshotAzureExportBucketResponse' GCP: '#/components/schemas/DiskBackupSnapshotGCPExportBucketResponse' propertyName: cloudProvider properties: _id: description: Unique 24-hexadecimal character string that identifies the Export Bucket. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string bucketName: description: The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to. example: export-bucket maxLength: 63 minLength: 3 type: string cloudProvider: description: Human-readable label that identifies the cloud provider. enum: - AWS - AZURE - GCP type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array required: - _id - bucketName - cloudProvider type: object BackupComplianceScheduledPolicyItem: description: Specifications for scheduled policy. properties: frequencyInterval: description: "Number that indicates the frequency interval for a set of Snapshots. A value of `1` specifies the first instance of the corresponding `frequencyType`.\n\n- In a yearly policy item, `1` indicates that the yearly Snapshot occurs on the first day of January and `12` indicates the first day of December.\n\n- In a monthly policy item, `1` indicates that the monthly Snapshot occurs on the first day of the month and `40` indicates the last day of the month.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- In an hourly policy item, you can set the frequency interval to `1`, `2`, `4`, `6`, `8`, or `12`. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only `12` as the frequency interval value.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings." enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 40 format: int32 type: integer frequencyType: description: Human-readable label that identifies the frequency type associated with the backup policy. enum: - daily - hourly - weekly - monthly - yearly type: string id: description: Unique 24-hexadecimal digit string that identifies this backup policy item. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string retentionUnit: description: Unit of time in which MongoDB Cloud measures Snapshot retention. enum: - days - weeks - months - years type: string retentionValue: description: 'Duration in days, weeks, months, or years that MongoDB Cloud retains the Snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. For example: If the hourly policy item specifies a retention of two days, you must specify two days or greater for the retention of the weekly policy item.' format: int32 type: integer required: - frequencyInterval - frequencyType - retentionUnit - retentionValue type: object DiskBackupReplicaSet: description: Details of the replica set snapshot that MongoDB Cloud created. properties: cloudProvider: description: Human-readable label that identifies the cloud provider. enum: - AWS - AZURE - GCP readOnly: true type: string copyRegions: description: List that identifies the regions to which MongoDB Cloud copies the snapshot. items: type: string readOnly: true type: array createdAt: description: Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string description: description: 'Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`.' readOnly: true type: string expiresAt: description: Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string frequencyType: description: Human-readable label that identifies how often this snapshot triggers. enum: - hourly - daily - weekly - monthly - yearly readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array masterKeyUUID: description: 'Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `"encryptionEnabled" : true`.' format: uuid readOnly: true type: string mongodVersion: description: Version of the MongoDB host that this snapshot backs up. pattern: ([\d]+\.[\d]+\.[\d]+) readOnly: true type: string policyItems: description: List that contains unique identifiers for the policy items. items: description: Unique 24-hexadecimal digit string that identifies one policy item. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string readOnly: true type: array replicaSetName: description: 'Human-readable label that identifies the replica set from which MongoDB Cloud took this snapshot. The resource returns this parameter when `"type": "replicaSet"`.' readOnly: true type: string snapshotType: description: Human-readable label that identifies when this snapshot triggers. enum: - onDemand - scheduled - fallback readOnly: true type: string status: description: Human-readable label that indicates the stage of the backup process for this snapshot. enum: - queued - inProgress - completed - failed readOnly: true type: string storageSizeBytes: description: Number of bytes taken to store the backup at time of snapshot. format: int64 readOnly: true type: integer type: description: Human-readable label that categorizes the cluster as a replica set or sharded cluster. enum: - replicaSet - shardedCluster readOnly: true type: string title: Replica Set Snapshot type: object BackupLabel: description: Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes. properties: key: description: Key for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes. type: string value: description: Value for the key to include in file that MongoDB Cloud uploads to the bucket when the export job finishes. type: string type: object BadRequestDetail: description: Bad request detail. properties: fields: description: Describes all violations in a client request. items: $ref: '#/components/schemas/FieldViolation' type: array readOnly: true type: object ApiBSONTimestampView: description: BSON timestamp that indicates when the checkpoint token entry in the oplog occurred. properties: date: description: Date and time when the oplog recorded this database operation. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string increment: description: Order of the database operation that the oplog recorded at specific date and time. example: 1199145600 format: int32 minimum: 1199145600 readOnly: true type: integer readOnly: true title: BSON Timestamp type: object DiskBackupOnDemandCopyPolicyItem: allOf: - $ref: '#/components/schemas/DiskBackupCopyPolicyItem' description: Specifications for one on-demand copy policy item. required: - frequencyType type: object DiskBackupExportJob: properties: components: description: Information on the export job for each replica set in the sharded cluster. items: $ref: '#/components/schemas/DiskBackupExportMember' readOnly: true type: array createdAt: description: Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string customData: description: Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: '#/components/schemas/BackupLabel' type: array exportBucketId: description: Unique 24-hexadecimal character string that identifies the Export Bucket. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string exportStatus: $ref: '#/components/schemas/ExportStatus' finishedAt: description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. format: date-time readOnly: true type: string id: description: Unique 24-hexadecimal character string that identifies the restore job. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array prefix: description: Prefix used for all blob storage objects uploaded as part of the Export Job. pattern: /exported_snapshots/\{ORG-NAME\}/\{PROJECT-NAME\}/\{CLUSTER-NAME\}/\{SNAPSHOT-INITIATION-DATE\}/\{TIMESTAMP\} readOnly: true type: string snapshotId: description: Unique 24-hexadecimal character string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string state: description: State of the Export Job. enum: - Cancelled - Failed - InProgress - Queued - Successful readOnly: true type: string stateReason: $ref: '#/components/schemas/StateReason' required: - exportBucketId type: object PaginatedApiAtlasDiskBackupExportJobView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/DiskBackupExportJob' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object PaginatedApiAtlasServerlessBackupSnapshotView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/ServerlessBackupSnapshot' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object AdvancedDiskBackupSnapshotSchedulePolicy: description: List that contains a document for each backup policy item in the desired backup policy. properties: id: description: Unique 24-hexadecimal digit string that identifies this backup policy. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string policyItems: description: List that contains the specifications for one policy. items: $ref: '#/components/schemas/DiskBackupApiPolicyItem' type: array required: - policyItems type: object DiskBackupExportMember: properties: exportId: description: Unique 24-hexadecimal character string that identifies the the Cloud Backup snapshot export job for each shard in a sharded cluster. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string replicaSetName: description: Human-readable label that identifies the replica set on the sharded cluster. readOnly: true type: string type: object DiskBackupCopyPolicyItem: description: Specifications for one copy policy item. discriminator: mapping: daily: '#/components/schemas/DiskBackupTimeBasedCopyPolicyItem' hourly: '#/components/schemas/DiskBackupTimeBasedCopyPolicyItem' monthly: '#/components/schemas/DiskBackupTimeBasedCopyPolicyItem' ondemand: '#/components/schemas/DiskBackupOnDemandCopyPolicyItem' weekly: '#/components/schemas/DiskBackupTimeBasedCopyPolicyItem' yearly: '#/components/schemas/DiskBackupTimeBasedCopyPolicyItem' propertyName: frequencyType oneOf: - $ref: '#/components/schemas/DiskBackupOnDemandCopyPolicyItem' - $ref: '#/components/schemas/DiskBackupTimeBasedCopyPolicyItem' properties: frequencyType: description: Human-readable label that identifies the frequency type associated with the copy policy. enum: - daily - hourly - weekly - monthly - yearly - ondemand type: string id: description: Unique 24-hexadecimal digit string that identifies this copy policy item. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string required: - frequencyType type: object StateReason: description: State reason of the Job. This is set when the job state is "Failed". properties: errorCode: description: Error code relating to state. type: string message: description: Message describing error or state. type: string readOnly: true type: object PaginatedApiAtlasObjectStoragePrivateEndpointResponseView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/ObjectStoragePrivateEndpointResponse' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object UpdateRequirePrivateNetworkingRequestView: description: Request body to toggle the private-networking requirement for an existing export bucket. properties: requirePrivateNetworking: description: True to require private networking; false to disable it. type: boolean required: - requirePrivateNetworking type: object PaginatedCloudBackupReplicaSetView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/DiskBackupReplicaSet' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object FieldViolation: properties: description: description: A description of why the request element is bad. type: string field: description: A path that leads to a field in the request body. type: string required: - description - field type: object DiskBackupSnapshotAWSExportBucketResponse: properties: _id: description: Unique 24-hexadecimal character string that identifies the Export Bucket. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string bucketName: description: The name of the AWS S3 Bucket, Azure Storage Container, or Google Cloud Storage Bucket that Snapshots are exported to. example: export-bucket maxLength: 63 minLength: 3 type: string cloudProvider: description: Human-readable label that identifies the cloud provider. enum: - AWS - AZURE - GCP type: string iamRoleId: description: Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket. example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Unified AWS Access role ID url: https://www.mongodb.com/docs/atlas/security/set-up-unified-aws-access/ pattern: ^([a-f0-9]{24})$ type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array region: description: AWS region for the export bucket. This is set by Atlas and is never user-supplied. example: us-east-1 readOnly: true type: string requirePrivateNetworking: description: Indicates whether to use private link. User supplied. type: boolean required: - _id - bucketName - cloudProvider - iamRoleId type: object DataProtectionSettings20231001: properties: authorizedEmail: description: Email address of the user who authorized to update the Backup Compliance Policy settings. format: email type: string authorizedUserFirstName: description: First name of the user who authorized to updated the Backup Compliance Policy settings. type: string authorizedUserLastName: description: Last name of the user who authorized to updated the Backup Compliance Policy settings. type: string copyProtectionEnabled: default: false description: Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed. If unspecified, this value defaults to false. type: boolean deletable: default: false description: Flag that indicates whether the Backup Compliance Policy is allowed to be disabled. It is default to false and a support ticket needs to be filed to request setting to true. externalDocs: description: Configure a Backup Compliance Policy url: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/ readOnly: true type: boolean encryptionAtRestEnabled: default: false description: Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false. externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ type: boolean onDemandPolicyItem: $ref: '#/components/schemas/BackupComplianceOnDemandPolicyItem' pitEnabled: default: false description: Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false. externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ type: boolean projectId: description: Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string restoreWindowDays: description: Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy. format: int32 type: integer scheduledPolicyItems: description: List that contains the specifications for one scheduled policy. items: $ref: '#/components/schemas/BackupComplianceScheduledPolicyItem' type: array state: description: Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings. enum: - ACTIVE - ENABLING - UPDATING - DISABLING readOnly: true type: string updatedDate: description: ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings. format: date-time readOnly: true type: string updatedUser: description: Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings. format: email readOnly: true type: string required: - authorizedEmail - authorizedUserFirstName - authorizedUserLastName type: object DiskBackupCopySetting20240805: description: Copy setting item in the desired backup policy. properties: cloudProvider: description: Human-readable label that identifies the cloud provider that stores the snapshot copy. enum: - AWS - AZURE - GCP type: string copyPolicyItems: description: List that contains a document for each copy policy item. Allowed only when `copyPolicyItemsEnabled` is true. Responses omit this field when `copyPolicyItemsEnabled` is false or omitted. items: $ref: '#/components/schemas/DiskBackupCopyPolicyItem' maxItems: 6 type: array frequencies: deprecated: true description: 'Deprecated: use `copyPolicyItems`, which defines which snapshots to copy and their retention. Allowed only when `copyPolicyItemsEnabled` is false or omitted. Responses omit this field when `copyPolicyItemsEnabled` is true.' items: enum: - HOURLY - DAILY - WEEKLY - MONTHLY - YEARLY - ON_DEMAND type: string maxItems: 6 type: array lastNumberOfSnapshots: description: Number of most recent snapshots to copy to the target region. If specified, Atlas copies this number of the most recent snapshots rather than using a frequency-based or policy-based copy schedule. This field is mutually exclusive with `frequencies` and `copyPolicyItems`. format: int32 maximum: 500 minimum: 1 type: integer regionName: description: Target region to copy snapshots belonging to `zoneId`. Please supply the 'Atlas Region'. externalDocs: description: Cloud Provider Regions url: https://www.mongodb.com/docs/atlas/reference/cloud-providers/ type: string shouldCopyOplogs: description: Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores. type: boolean zoneId: description: Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the `replicationSpecs` array. example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster From One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string required: - zoneId type: object DiskBackupSnapshot: discriminator: mapping: replicaSet: '#/components/schemas/DiskBackupReplicaSet' shardedCluster: '#/components/schemas/DiskBackupShardedClusterSnapshot' propertyName: type properties: createdAt: description: Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string description: description: 'Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`.' readOnly: true type: string expiresAt: description: Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string frequencyType: description: Human-readable label that identifies how often this snapshot triggers. enum: - hourly - daily - weekly - monthly - yearly readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array masterKeyUUID: description: 'Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `"encryptionEnabled" : true`.' format: uuid readOnly: true type: string mongodVersion: description: Version of the MongoDB host that this snapshot backs up. pattern: ([\d]+\.[\d]+\.[\d]+) readOnly: true type: string policyItems: description: List that contains unique identifiers for the policy items. items: description: Unique 24-hexadecimal digit string that identifies one policy item. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string readOnly: true type: array snapshotType: description: Human-readable label that identifies when this snapshot triggers. enum: - onDemand - scheduled - fallback readOnly: true type: string status: description: Human-readable label that indicates the stage of the backup process for this snapshot. enum: - queued - inProgress - completed - failed readOnly: true type: string storageSizeBytes: description: Number of bytes taken to store the backup at time of snapshot. format: int64 readOnly: true type: integer type: description: Human-readable label that categorizes the cluster as a replica set or sharded cluster. enum: - replicaSet - shardedCluster readOnly: true type: string type: object DeleteCopiedBackups20240805: description: Deleted copy setting whose backup copies need to also be deleted. properties: cloudProvider: description: Human-readable label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete. enum: - AWS - AZURE - GCP type: string writeOnly: true regionName: description: Target region for the deleted copy setting whose backup copies you want to delete. Please supply the 'Atlas Region'. externalDocs: description: Cloud Provider Regions url: https://www.mongodb.com/docs/atlas/reference/cloud-providers/ type: string writeOnly: true zoneId: description: Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Zone Id, do a GET request to Return One Cluster from One Project and consult the `replicationSpecs` array. example: 32b6e34b3d91647abb20e7b8 externalDocs: description: Return One Cluster from One Project url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster pattern: ^([a-f0-9]{24})$ type: string writeOnly: true type: object writeOnly: true PaginatedBackupSnapshotExportBucketsView: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array results: description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: '#/components/schemas/DiskBackupSnapshotExportBucketResponse' readOnly: true type: array totalCount: description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. format: int32 minimum: 0 readOnly: true type: integer required: - results type: object DiskBackupShardedClusterSnapshot: description: Details of the sharded cluster snapshot that MongoDB Cloud created. properties: configServerType: description: Describes a sharded cluster's config server type. enum: - EMBEDDED - DEDICATED readOnly: true type: string createdAt: description: Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string description: description: 'Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when `"status": "onDemand"`.' readOnly: true type: string expiresAt: description: Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string frequencyType: description: Human-readable label that identifies how often this snapshot triggers. enum: - hourly - daily - weekly - monthly - yearly readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array masterKeyUUID: description: 'Unique string that identifies the Amazon Web Services (AWS) Key Management Service (KMS) Customer Master Key (CMK) used to encrypt the snapshot. The resource returns this value when `"encryptionEnabled" : true`.' format: uuid readOnly: true type: string members: description: 'List that includes the snapshots and the cloud provider that stores the snapshots. The resource returns this parameter when `"type" : "SHARDED_CLUSTER"`.' items: $ref: '#/components/schemas/DiskBackupShardedClusterSnapshotMember' readOnly: true type: array mongodVersion: description: Version of the MongoDB host that this snapshot backs up. pattern: ([\d]+\.[\d]+\.[\d]+) readOnly: true type: string policyItems: description: List that contains unique identifiers for the policy items. items: description: Unique 24-hexadecimal digit string that identifies one policy item. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string readOnly: true type: array snapshotIds: description: 'List that contains the unique identifiers of the snapshots created for the shards and config host for a sharded cluster. The resource returns this parameter when `"type": "SHARDED_CLUSTER"`. These identifiers should match the ones specified in the **members[n].id** parameters. This allows you to map a snapshot to its shard or config host name.' items: description: Unique 24-hexadecimal digit string that identifies the snapshot for part of the sharded cluster. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string readOnly: true type: array snapshotType: description: Human-readable label that identifies when this snapshot triggers. enum: - onDemand - scheduled - fallback readOnly: true type: string status: description: Human-readable label that indicates the stage of the backup process for this snapshot. enum: - queued - inProgress - completed - failed readOnly: true type: string storageSizeBytes: description: Number of bytes taken to store the backup at time of snapshot. format: int64 readOnly: true type: integer type: description: Human-readable label that categorizes the cluster as a replica set or sharded cluster. enum: - replicaSet - shardedCluster readOnly: true type: string title: Sharded Cluster Snapshot type: object DiskBackupSnapshotRestoreJob: properties: cancelled: description: Flag that indicates whether someone canceled this restore job. readOnly: true type: boolean components: description: Information on the restore job for each replica set in the sharded cluster. items: $ref: '#/components/schemas/DiskBackupRestoreMember' readOnly: true type: array deliveryType: description: Human-readable label that categorizes the restore job to create. enum: - automated - download - pointInTime type: string deliveryUrl: description: 'One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `"deliveryType" : "download"`.' items: description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. type: string readOnly: true type: array desiredTimestamp: $ref: '#/components/schemas/ApiBSONTimestampView' expired: description: Flag that indicates whether the restore job expired. readOnly: true type: boolean expiresAt: description: Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string failed: description: Flag that indicates whether the restore job failed. readOnly: true type: boolean finishedAt: description: Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string id: description: Unique 24-hexadecimal character string that identifies the restore job. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array oplogInc: description: 'Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `"deliveryType" : "pointInTime"` and `oplogTs` exceeds `0`.' example: 1 format: int32 minimum: 1 type: integer oplogTs: description: 'Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `"deliveryType" : "pointInTime"` and `oplogTs` exceeds `0`.' format: int32 minimum: 1199145600 type: integer pointInTimeUTCSeconds: description: 'Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `"deliveryType" : "pointInTime"` and `pointInTimeUTCSeconds` exceeds `0`.' format: int32 minimum: 1199145600 type: integer privateDownloadDeliveryUrls: description: 'One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download and the corresponding private endpoint(s). MongoDB Cloud returns this parameter when `"deliveryType" : "download"` and the download can be performed privately.' items: $ref: '#/components/schemas/ApiPrivateDownloadDeliveryUrl' readOnly: true type: array snapshotId: description: Unique 24-hexadecimal character string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string targetClusterName: description: Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `"deliveryType":` `"automated"`. Required for `automated` and `pointInTime` restore types. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string targetGroupId: description: Unique 24-hexadecimal digit string that identifies the target project for the specified `targetClusterName`. Required for `automated` and `pointInTime` restore types. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string timestamp: description: Date and time when MongoDB Cloud took the snapshot associated with `snapshotId`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string required: - deliveryType type: object DiskBackupShardedClusterSnapshotMember: properties: cloudProvider: description: Human-readable label that identifies the cloud provider. enum: - AWS - AZURE - GCP readOnly: true type: string id: description: Unique 24-hexadecimal digit string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string replicaSetName: description: Human-readable label that identifies the shard or config host from which MongoDB Cloud took this snapshot. readOnly: true type: string required: - cloudProvider - id - replicaSetName type: object BackupSnapshotRetention: properties: links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array retentionUnit: description: Quantity of time in which MongoDB Cloud measures snapshot retention. enum: - DAYS - WEEKS - MONTHS - YEARS type: string retentionValue: description: Number that indicates the amount of days, weeks, months, or years that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item. example: 5 format: int32 type: integer required: - retentionUnit - retentionValue type: object ServerlessBackupRestoreJob: properties: cancelled: description: Flag that indicates whether someone canceled this restore job. readOnly: true type: boolean deliveryType: description: Human-readable label that categorizes the restore job to create. enum: - automated - download - pointInTime type: string deliveryUrl: description: 'One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `"deliveryType" : "download"`.' items: description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. type: string readOnly: true type: array desiredTimestamp: $ref: '#/components/schemas/ApiBSONTimestampView' expired: description: Flag that indicates whether the restore job expired. readOnly: true type: boolean expiresAt: description: Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string failed: description: Flag that indicates whether the restore job failed. readOnly: true type: boolean finishedAt: description: Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string id: description: Unique 24-hexadecimal character string that identifies the restore job. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ readOnly: true type: string links: description: 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. externalDocs: description: Web Linking Specification (RFC 5988) url: https://datatracker.ietf.org/doc/html/rfc5988 items: $ref: '#/components/schemas/Link' readOnly: true type: array oplogInc: description: 'Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `"deliveryType" : "pointInTime"` and `oplogTs` exceeds `0`.' example: 1 format: int32 minimum: 1 type: integer oplogTs: description: 'Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when `"deliveryType" : "pointInTime"` and `oplogTs` exceeds `0`.' format: int32 minimum: 1199145600 type: integer pointInTimeUTCSeconds: description: 'Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when `"deliveryType" : "pointInTime"` and `pointInTimeUTCSeconds` exceeds `0`.' format: int32 minimum: 1199145600 type: integer snapshotId: description: Unique 24-hexadecimal character string that identifies the snapshot. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string targetClusterName: description: Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when `"deliveryType":` `"automated"`. pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ type: string targetGroupId: description: Unique 24-hexadecimal digit string that identifies the target project for the specified `targetClusterName`. example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string timestamp: description: Date and time when MongoDB Cloud took the snapshot associated with `snapshotId`. This parameter expresses its value in the ISO 8601 timestamp format in UTC. format: date-time readOnly: true type: string required: - deliveryType - targetClusterName - targetGroupId type: object DiskBackupRestoreMember: properties: downloadUrl: description: 'One Uniform Resource Locator that points to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `"deliveryType" : "download"`.' readOnly: true type: string privateDownloadDeliveryUrls: description: 'One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download and the corresponding private endpoint(s). MongoDB Cloud returns this parameter when `"deliveryType" : "download"` and the download can be performed privately.' items: $ref: '#/components/schemas/ApiPrivateDownloadDeliveryUrl' readOnly: true type: array replicaSetName: description: Human-readable label that identifies the replica set on the sharded cluster. readOnly: true type: string type: object responses: internalServerError: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 500 errorCode: UNEXPECTED_ERROR reason: Internal Server Error schema: $ref: '#/components/schemas/ApiError' description: Internal Server Error. methodNotAllowed: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 405 errorCode: ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED reason: Method Not Allowed schema: $ref: '#/components/schemas/ApiError' description: Method Not Allowed. forbidden: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 403 errorCode: CANNOT_CHANGE_GROUP_NAME reason: Forbidden schema: $ref: '#/components/schemas/ApiError' description: Forbidden. tooManyRequests: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 429 errorCode: RATE_LIMITED reason: Too Many Requests schema: $ref: '#/components/schemas/ApiError' description: Too Many Requests. headers: RateLimit-Limit: $ref: '#/components/headers/HeaderRateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/HeaderRateLimitRemaining' Retry-After: $ref: '#/components/headers/HeaderRetryAfter' unauthorized: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) error: 401 errorCode: NOT_ORG_GROUP_CREATOR reason: Unauthorized schema: $ref: '#/components/schemas/ApiError' description: Unauthorized. conflict: content: application/json: example: detail: '(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554' error: 409 errorCode: CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK reason: Conflict schema: $ref: '#/components/schemas/ApiError' description: Conflict. badRequest: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) No provider AWS exists. error: 400 errorCode: VALIDATION_ERROR reason: Bad Request schema: $ref: '#/components/schemas/ApiError' description: Bad Request. notFound: content: application/json: example: detail: (This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS error: 404 errorCode: RESOURCE_NOT_FOUND reason: Not Found schema: $ref: '#/components/schemas/ApiError' description: Not Found. parameters: envelope: description: 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. in: query name: envelope schema: default: false type: boolean groupId: description: '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.' in: path name: groupId required: true schema: example: 32b6e34b3d91647abb20e7b8 pattern: ^([a-f0-9]{24})$ type: string itemsPerPage: description: Number of items that the response returns per page. in: query name: itemsPerPage schema: default: 100 maximum: 500 minimum: 1 type: integer pretty: description: Flag that indicates whether the response body should be in the prettyprint format. in: query name: pretty schema: default: false externalDocs: description: Prettyprint url: https://en.wikipedia.org/wiki/Prettyprint type: boolean pageNum: description: Number of the page that displays the current set of the total objects that the response returns. in: query name: pageNum schema: default: 1 minimum: 1 type: integer includeCount: description: Flag that indicates whether the response returns the total number of items (`totalCount`) in the response. in: query name: includeCount schema: default: true type: boolean headers: HeaderRetryAfter: description: The minimum time you should wait, in seconds, before retrying the API request. This header might be returned for 429 or 503 error responses. schema: type: integer HeaderRateLimitLimit: description: The maximum number of requests that a user can make within a specific time window. schema: type: integer HeaderRateLimitRemaining: description: The number of requests remaining in the current rate limit window before the limit is reached. schema: type: integer securitySchemes: DigestAuth: scheme: digest type: http ServiceAccounts: description: Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview). flows: clientCredentials: scopes: {} tokenUrl: https://cloud.mongodb.com/api/oauth/token type: oauth2 x-externalLinks: - label: Back to Atlas Docs url: https://www.mongodb.com/docs/atlas/ - label: API Changelog url: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/ x-topics: - content: The MongoDB Atlas Administration API is rate limited. To learn more about rate limiting, see the [Atlas Documentation on Rate Limiting](http://dochub.mongodb.org/core/atlas-api-rate-limit) title: Rate Limiting