Navigation
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.

Update One S3 Blockstore Configuration

On this page

Updates the configuration of one s3 blockstore.

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

Resource

copy 
PUT /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 Necessity Description Default
pretty boolean Optional Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag that indicates 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
false

Request Body Parameters

Name Type Necessity Description
acceptedTos boolean Required

Flag that indicates whether or not you accepted the terms of service for using S3-compatible stores with Ops Manager. You must set this to true to create an S3-compatible store.

If you set this to false, Ops Manager returns an error. The error states that Ops Manager can’t create the S3-compatible store.
assignmentEnabled boolean Optional Flag that indicates whether you can assign backup jobs to this data store.
awsAccessKey string Conditional

AWS Access Key ID that can access the S3 bucket specified in s3BucketName.

If "s3AuthMethod" : "IAM_ROLE", then you don’t need to include awsAccessKey.
awsSecretKey string Conditional

AWS Secret Access Key that can access the S3 bucket specified in <s3BucketName>.

If "s3AuthMethod" : "IAM_ROLE", then you don’t need to include awsSecretKey.
customCertificates array Optional List of valid Certificate Authority certificates that apply to the associated S3 bucket.
customCertificates[n].filename string Optional Name that identifies the Certificate Authority PEM file.
customCertificates[n].certString string Optional Contents of the Certificate Authority PEM file that comprise your Certificate Authority chain.
disableProxyS3 boolean Optional Flag that indicates whether the HTTP proxy should be used when connecting to S3. You don’t need to set this value unless you configured Ops Manager to use the HTTP proxy.
encryptedCredentials boolean Optional Flag that indicates whether the username and password for this S3 blockstore were encrypted using the credentialstool.
labels array of strings Optional

Array of tags to manage which backup jobs Ops Manager can assign to which S3 blockstores.

Setting these tags limits which backup jobs this S3 blockstore can process. If omitted, this S3 blockstore can only process backup jobs for projects that do not use labels to filter their jobs.
loadFactor number Optional

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 Required

Flag that indicates the style of this endpoint.

Value S3 Blockstore Endpoint Style Example
true Path-style URL endpoint s3.amazonaws.com/<bucket>
false Virtual-host-style URL endpoint <bucket>.s3.amazonaws.com

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

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

Ops Manager accepts the following values:

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 Required URL used to access this AWS S3 or S3-compatible bucket.
s3BucketName string Required Name of the S3 bucket that hosts the S3 blockstore.
s3MaxConnections number Required Positive integer indicating the maximum number of connections to this S3 blockstore.
s3RegionOverride string Conditional

Region where your S3 bucket resides.

Use this field only if your S3-compatible store’s s3BucketEndpoint doesn’t support region scoping. Don’t use this field with AWS S3 buckets.
sseEnabled boolean Required Flag that indicates whether this S3 blockstore enables server-side encryption.
uri string Required Comma-separated list of hosts in the <hostname:port> format that can access this S3 blockstore.
ssl boolean Optional Flag that indicates whether this S3 blockstore only accepts connections encrypted using TLS.
writeConcern string Optional

Write concern used for this blockstore.

Ops Manager accepts the following values:

  • ACKNOWLEDGED
  • W2
  • JOURNALED
  • MAJORITY

See also

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

Response

Name Type Description
acceptedTos boolean Flag that indicates whether or not you accepted the terms of service for using S3-compatible stores with Ops Manager. You must set this to true to create an S3-compatible store.
assignmentEnabled boolean Flag that indicates 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.
customCertificates array List of valid Certificate Authority certificates that apply to the associated S3 bucket.
customCertificates[n].filename string Name that identifies the Certificate Authority PEM file.
customCertificates[n].certString string Contents of the Certificate Authority PEM file that comprise your Certificate Authority chain.
disableProxyS3 boolean Flag that indicates whether the HTTP proxy should be used when connecting to S3.
encryptedCredentials boolean Flag that indicates whether the username and password for this S3 blockstore were encrypted using the credentialstool.
id string Name that uniquely identifies 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. All links arrays in responses include at least one link called self. The relationships 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 that indicates the style of this endpoint.

Value S3 Blockstore Endpoint Style Example
true Path-style URL endpoint s3.amazonaws.com/<bucket>
false Virtual-host-style URL endpoint <bucket>.s3.amazonaws.com

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 that indicates whether this S3 blockstore enables server-side encryption.
ssl boolean Flag that indicates whether this S3 blockstore only accepts connections encrypted using TLS.
uri string Connection String that connects to the metadata database for this S3 blockstore. This database stores the locations of the blocks in the AWS S3 bucket.
writeConcern string

Write concern used for this blockstore.

Ops Manager returns one of the following values:

  • ACKNOWLEDGED
  • W2
  • JOURNALED
  • MAJORITY

See also

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

Example Request

copy 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \
     --data '{
       "assignmentEnabled": true,
       "awsAccessKey": "<access>",
       "awsSecretKey": "<secret>",
       "encryptedCredentials": false,
       "labels": [
         "l1",
         "l2"
       ],
       "loadFactor": 50,
       "s3BucketEndpoint": "http://example.com/backupbucket",
       "s3BucketName": "bucketname",
       "uri": "mongodb://localhost:27017",
       "ssl": true,
       "writeConcern": "W2"
     }'
copy 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \
     --data '{
       "assignmentEnabled": true,
       "encryptedCredentials": false,
       "labels": [
         "l1",
         "l2"
       ],
       "loadFactor": 50,
       "s3AuthMethod": "IAM_ROLE",
       "s3BucketEndpoint": "http://example.com/backupbucket",
       "s3BucketName": "bucketname",
       "uri": "mongodb://localhost:27017",
       "ssl": true,
       "writeConcern": "W2"
     }'

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

 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
{
  "acceptedTos": true,
  "assignmentEnabled": true,
  "awsAccessKey": "<access>",
  "awsSecretKey": "<secret>",
  "encryptedCredentials": false,
  "id": "{S3-BLOCKSTORE-CONFIG-ID}",
  "labels": [
    "l1",
    "l2"
  ],
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
      "rel": "self"
    }
  ],
  "loadFactor": 50,
  "pathStyleAccessEnabled": false,
  "s3AuthMethod": "KEYS",
  "s3BucketEndpoint": "http://example.com/backupbucket",
  "s3BucketName": "bucketname",
  "s3MaxConnections": 50,
  "sseEnabled": true,
  "ssl": false,
  "uri": "mongodb://127.0.0.1:27017",
  "writeConcern": "W2"
}

 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
{
  "acceptedTos": true,
  "assignmentEnabled": true,
  "encryptedCredentials": false,
  "id": "{S3-BLOCKSTORE-CONFIG-ID}",
  "labels": [
    "l1",
    "l2"
  ],
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/backup/snapshot/s3Configs",
      "rel": "self"
    }
  ],
  "loadFactor": 50,
  "pathStyleAccessEnabled": false,
  "s3AuthMethod": "IAM_ROLE",
  "s3BucketEndpoint": "http://example.com/backupbucket",
  "s3BucketName": "bucketname",
  "s3MaxConnections": 50,
  "sseEnabled": true,
  "ssl": false,
  "uri": "mongodb://127.0.0.1:27017",
  "writeConcern": "W2"
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.