This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.
This version of the manual is no longer supported.

Get One S3 Blockstore Configuration by ID

Retrieves the configuration of one s3 blockstore.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup


GET /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}

Request Path Parameters

Name Type Description
S3-BLOCKSTORE-CONFIG-ID string The unique name that labels this S3 blockstore configuration.

Request Query Parameters

The following query parameters are optional:

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

Flag indicating whether or not to wrap the response in an envelope.

Some API 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:

Name Description
status HTTP response code
envelope Expected response body

Request Body Parameters

This endpoint does not use HTTP request body parameters.


Name Type Description
acceptedTos boolean Flag indicating whether or not you accepted the terms of service for using S3-compatible stores with Ops Manager. If this is false, the request results in an error and Ops Manager doesn’t create the S3-compatible store.
assignmentEnabled boolean Flag indicating whether you can assign backup jobs to this data store.
awsAccessKey string AWS Access Key ID that can access the S3 bucket specified in s3BucketName.
awsSecretKey string AWS Secret Access Key that can access the S3 bucket specified in s3BucketName.
disableProxyS3 boolean Flag indicating whether the HTTP proxy should be used when connecting to S3.
encryptedCredentials boolean Flag indicating whether the username and password for this S3 blockstore were encrypted using the credentialstool.
id string Unique name that labels this S3 blockstore.
labels array of strings Array of tags to manage which backup jobs Ops Manager can assign to which S3 blockstores.
links object array One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification
loadFactor integer

Positive, non-zero integer that expresses how much backup work this snapshot store performs compared to another snapshot store. This option is needed only if more than one snapshot store is in use.

See also

To learn more about Load Factor, see Edit an Existing |s3| Blockstore

pathStyleAccessEnabled boolean

Flag indicating the style of this endpoint.

Value S3 Blockstore Endpoint Style Example
true Path-style URL endpoint<bucket>
false Virtual-host-style URL endpoint <bucket>

To review the S3 bucket URL conventions, see the AWS S3 documentation.

s3AuthMethod string

Method used to authorize access to the S3 bucket specified in s3BucketName.

Accepted values for this option are: KEYS, IAM_ROLE.

KEYS or None Ops Manager uses awsAccessKey and awsSecretKey to authorize access to S3 bucket specified in s3BucketName.
IAM_ROLE Ops Manager uses an AWS IAM role to authorize access to S3 bucket specified in s3BucketName. awsAccessKey and awsSecretKey fields are ignored. To learn more, see the AWS documentation
s3BucketEndpoint string URL that Ops Manager uses to access this AWS S3 or S3-compatible bucket.
s3BucketName string Name of the S3 bucket that hosts the S3 blockstore.
s3MaxConnections integer Positive integer indicating the maximum number of connections to this S3 blockstore.
s3RegionOverride string

Region where your S3 bucket resides. This field applies only if your S3-compatible store’s s3BucketEndpoint doesn’t support region scoping.

Ops Manager returns this field only if you included it when you created or updated this S3 blockstore.

sseEnabled boolean Flag indicating whether this S3 blockstore enables server-side encryption.
uri string Comma-separated list of hosts in the <hostname:port> format that can access this S3 blockstore.
ssl boolean Flag indicating whether this S3 blockstore only accepts connections encrypted using TLS.
writeConcern string

Write concern used for this blockstore.

Accepted values for this option are:

  • W2

See also

To learn about write acknowledgement levels in MongoDB, see Write Concern

Example Request

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

  "assignmentEnabled": true,
  "awsAccessKey": "access",
  "awsSecretKey": "secret",
  "encryptedCredentials": false,
  "id": "id",
  "labels": [
  "links": [
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}",
      "rel": "self"
  "loadFactor": 50,
  "s3BucketEndpoint": "",
  "s3BucketName": "buck1",
  "uri": "mongodb://localhost:27017",
  "ssl": true,
  "writeConcern": "W2"