Docs Menu

Get One Snapshot Export Bucket

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response

The exportBuckets resource allows you to retrieve one bucket specified by the bucket ID.

The Atlas Administration API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Configure Atlas Administration API 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.

https://cloud.mongodb.com/api/atlas/v1.0

POST /groups/{GROUP-ID}/backup/exportBuckets/{BUCKET-ID}
Parameter
Type
Description
BUCKET-ID
string
Unqiue identifier of the bucket to retrieve.
GROUP-ID
string
Unique 24-hexadecimal digit string that identifies the project for which to grant access to the S3 bucket.

This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

status
HTTP response code
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

The HTTP document contains the following elements:

Parameter
Type
Description
id
string
Unique identifier of the S3 bucket.
bucketName
string
Name of the bucket that the role ID is authorized to access.
cloudProvider
string
Name of the provider of the cloud service where Atlas can access the S3 bucket. Atlas only supports AWS.
iamRoleId
string
Unique identifier of the role that Atlas uses to access the bucket.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" -X GET --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
"https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/backup/exportBuckets/{BUCKET-ID}?pretty=true"
{
"_id": "{BUCKET-ID}",
"bucketName": "example-bucket",
"cloudProvider": "AWS",
"iamRoleId": "12345678f901a234dbdb00ca",
}
Give Feedback
MongoDB logo
© 2021 MongoDB, Inc.

About

  • Careers
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2021 MongoDB, Inc.