MOmongodb
Cloud Backups

Create One Snapshot Export Bucket

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.

post/api/atlas/v2/groups/{groupId}/backup/exportBuckets

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

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

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Query parameters

envelopeboolean

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.

prettyboolean

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

Request body

cloudProvider'AWS' | 'AZURE' | 'GCP' required

Human-readable label that identifies the cloud provider.

bucketNamestring required

Human-readable label that identifies the AWS S3 Bucket that the role is authorized to export to.

iamRoleIdstring required

Unique 24-hexadecimal character string that identifies the Unified AWS Access role ID that MongoDB Cloud uses to access the AWS S3 bucket.

requirePrivateNetworkingboolean

Indicates whether to do exports over PrivateLink as opposed to public IPs. Defaults to False.

Example request

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "bucketName": "export-bucket",
  "iamRoleId": "32b6e34b3d91647abb20e7b8"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.