Create One S3 Oplog Configuration¶

On this page

Resource
Response
Example Request
Example Response
- Response Header
- Response Body

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 does not 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. 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.

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 oplog store were encrypted using the credentialstool.

id string Required Name that uniquely identifies this S3 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 oplog store can process. If omitted, this S3 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.

Value	S3 Oplog Store 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 oplog store.

s3MaxConnections number Required Positive integer indicating the maximum number of connections to this S3 oplog store.

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 oplog store enables server-side encryption.

ssl boolean Optional Flag that indicates whether this S3 oplog store only accepts connections encrypted using TLS.

uri string Required Connection String that connects to the metadata database for this S3 oplog store. This database stores the locations of the blocks in the AWS S3 bucket.

writeConcern

string

Optional

Write concern used for this oplog store.

Ops Manager accepts the following values:

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

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.

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 oplog store were encrypted using the credentialstool.

id string Name that uniquely identifies this S3 oplog store.

labels array of strings Array of tags to manage which backup jobs Ops Manager can assign to which S3 oplog stores.

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.

pathStyleAccessEnabled

boolean

Flag that indicates the style of this endpoint.

Value	S3 Oplog Store 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.

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 oplog store.

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 oplog store.

sseEnabled boolean Flag that indicates whether this S3 oplog store enables server-side encryption.

ssl boolean Flag that indicates whether this S3 oplog store only accepts connections encrypted using TLS.

uri string Connection String that connects to the metadata database for this S3 oplog store. This database stores the locations of the blocks in the AWS S3 bucket.

writeConcern

string

Write concern used for this oplog store.

Ops Manager returns one of the following values:

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

Example Request¶

copy

curl --user '{USERNAME}:{APIKEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true' \
     --data '{
       "assignmentEnabled": true,
       "awsAccessKey": "access",
       "awsSecretKey": "secret",
       "encryptedCredentials": false,
       "labels": [
         "l1",
         "l2"
       ],
       "s3BucketEndpoint": "http://backup.example.com/oplog",
       "s3BucketName": "oplog",
       "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¶

copy

{
  "assignmentEnabled": true,
  "awsAccessKey": "access",
  "awsSecretKey": "secret",
  "encryptedCredentials": false,
  "id": "id",
  "labels": [
    "l1",
    "l2"
  ],
  "links": [
    {
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs",
      "rel": "self"
    }
  ],
  "s3BucketEndpoint": "http://backup.example.com/oplog",
  "s3BucketName": "oplog",
  "uri": "mongodb://localhost:27017",
  "ssl": true,
  "writeConcern": "W2"
}

← Get All S3 Oplog Configurations Update One S3 Oplog Configuration →