Create One S3 Oplog Configuration
On this page
Configures one new s3 oplog store.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /oplog/s3Configs
Request Path Parameters
This endpoint doesn't use HTTP request path parameters.
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. |
| ||||||
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:
|
|
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 storage stores with Ops Manager. You
must set this to If you set this to | |||||||||
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-compatible storage bucket specified in s3BucketName. If | |||||||||
awsSecretKey | string | Conditional | AWS Secret Access Key that can access the S3-compatible storage bucket
specified in If | |||||||||
customCertificates | array | Optional | List of valid Certificate Authority certificates that apply to the associated S3-compatible storage 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-compatible storage. 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-compatible storage oplog store were encrypted using the credentialstool. | |||||||||
id | string | Required | Name that uniquely identifies this S3-compatible storage oplog store. | |||||||||
labels | array of strings | Optional | Array of tags to manage which backup jobs Ops Manager can assign to which S3 oplog stores. Setting these tags limits which backup jobs this S3-compatible storage oplog store can process. If omitted, this S3-compatible storage oplog store can only process backup jobs for projects that do not use labels to filter their jobs. | |||||||||
pathStyleAccessEnabled | boolean | Required | Flag that indicates the style of this endpoint.
To review the S3-compatible storage bucket URL conventions, see the AWS S3 documentation. | |||||||||
s3AuthMethod | string | Optional | Method used to authorize access to the S3-compatible storage bucket specified in s3BucketName. Ops Manager accepts the following values:
| |||||||||
s3BucketEndpoint | string | Required | URL used to access this S3-compatible storage bucket. | |||||||||
s3BucketName | string | Required | Name of the S3-compatible storage bucket that hosts the S3-compatible storage oplog store. | |||||||||
s3MaxConnections | number | Required | Positive integer indicating the maximum number of connections to this S3-compatible storage oplog store. | |||||||||
s3RegionOverride | string | Conditional | Region where your S3-compatible storage bucket resides. Use this field only if your S3-compatible storage 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-compatible storage oplog store enables server-side encryption. | |||||||||
ssl | boolean | Optional | Flag that indicates whether this S3-compatible storage oplog store only accepts connections encrypted using TLS. | |||||||||
uri | string | Required | Connection String that connects to the metadata database for this S3-compatible storage oplog store. This database stores the locations of the blocks in the S3-compatible storage bucket. | |||||||||
writeConcern | string | Optional | Write concern used for this oplog store. Ops Manager accepts the following values:
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 storage stores with Ops Manager. You
must set this to | |||||||||
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-compatible storage bucket specified in s3BucketName. | |||||||||
awsSecretKey | string | AWS Secret Access Key that can access the S3-compatible storage bucket specified in s3BucketName. | |||||||||
customCertificates | array | List of valid Certificate Authority certificates that apply to the associated S3-compatible storage 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-compatible storage. | |||||||||
encryptedCredentials | boolean | Flag that indicates whether the username and password for this S3-compatible storage oplog store were encrypted using the credentialstool. | |||||||||
id | string | Name that uniquely identifies this S3-compatible storage oplog store. | |||||||||
labels | array of strings | Array of tags to manage which backup jobs Ops Manager can assign to which S3-compatible storage oplog stores. | |||||||||
links | object array | One or more links to sub-resources and/or related resources. All
| |||||||||
pathStyleAccessEnabled | boolean | Flag that indicates the style of this endpoint.
To review the S3-compatible storage bucket URL conventions, see the AWS S3 documentation. | |||||||||
s3BucketEndpoint | string | URL that Ops Manager uses to access this S3-compatible storage bucket. | |||||||||
s3BucketName | string | Name of the S3-compatible storage bucket that hosts the S3-compatible storage oplog store. | |||||||||
s3RegionOverride | string | ||||||||||
sseEnabled | boolean | Flag that indicates whether this S3-compatible storage oplog store enables server-side encryption. | |||||||||
ssl | boolean | Flag that indicates whether this S3-compatible storage oplog store only accepts connections encrypted using TLS. | |||||||||
uri | string | Connection String that connects to the metadata database for this S3-compatible storage oplog store. This database stores the locations of the blocks in the S3-compatible storage bucket. | |||||||||
writeConcern | string | Write concern used for this oplog store. Ops Manager returns one of the following values:
To learn about write acknowledgement levels in MongoDB, see Write Concern. |
Example Request
1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true' \ 6 --data '{ 7 "assignmentEnabled": true, 8 "awsAccessKey": "access", 9 "awsSecretKey": "secret", 10 "encryptedCredentials": false, 11 "id": "{S3-OPLOG-CONFIG-ID}", 12 "labels": [ 13 "l1", 14 "l2" 15 ], 16 "s3BucketEndpoint": "http://backup.example.com/oplog", 17 "s3BucketName": "oplog", 18 "uri": "mongodb://localhost:27017", 19 "ssl": true, 20 "writeConcern": "W2" 21 }'
Example Response
Response Header
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
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 "assignmentEnabled": true, 3 "awsAccessKey": "access", 4 "awsSecretKey": "secret", 5 "encryptedCredentials": false, 6 "id": "{S3-OPLOG-CONFIG-ID}", 7 "labels": [ 8 "l1", 9 "l2" 10 ], 11 "links": [ 12 { 13 "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs", 14 "rel": "self" 15 } 16 ], 17 "s3BucketEndpoint": "http://backup.example.com/oplog", 18 "s3BucketName": "oplog", 19 "uri": "mongodb://localhost:27017", 20 "ssl": true, 21 "writeConcern": "W2" 22 }