- API >
- Public API Resources >
- Backup and Restore >
- S3 Oplog Configurations >
- Create One S3 Oplog Configuration
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¶
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:
|
false |
Request Body Parameters¶
Name | Type | Description |
---|---|---|
assignmentEnabled | boolean | Optional. Flag indicating whether this data store can be assigned backup jobs. |
awsAccessKey | string | The AWS Access Key ID that can access the S3 bucket specified in
<s3BucketName> . |
awsSecretKey | string | The AWS Secret Access Key that can access the S3 bucket
specified in <s3BucketName> . |
encryptedCredentials | boolean | Optional. Flag indicating whether the username and password for this S3 oplog store were encrypted using the credentialstool. |
id | string | The unique name that labels 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 | Optional. Flag indicating whether this S3 blockstore
uses a path-style URL
endpoint ( To review the S3 bucket URL conventions, see the AWS S3 documentation |
s3BucketEndpoint | string | The URL used to access this AWS S3 or S3-compatible bucket. |
s3BucketName | string | The name of the S3 bucket that hosts the S3 oplog store. |
sseEnabled | boolean |
|
uri | string | A comma-separated list of hosts in the <hostname:port> format
that can be used to access this S3 oplog store. |
ssl | boolean | Optional. Flag indicating whether this S3 oplog store only accepts connections encrypted using TLS. |
writeConcern | string | Optional. The write concern used for this oplog store. The accepted values for this option are:
See also To learn about write acknowledgement levels in MongoDB, see Write Concern |
Response¶
Name | Type | Description |
---|---|---|
assignmentEnabled | boolean | Flag indicating whether this data store can be assigned backup jobs. |
awsAccessKey | string | The AWS Access Key ID that can access the S3 bucket specified in
<s3BucketName> . |
awsSecretKey | string | The AWS Secret Access Key that can access the S3 bucket
specified in <s3BucketName> . |
encryptedCredentials | boolean | Flag indicating whether the username and password for this S3 oplog store were encrypted using the credentialstool. |
id | string | The unique name that labels 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 | Optional. Flag indicating whether this S3 oplog store
uses a path-style URL
endpoint (s3.amazonaws.com/<bucket> ) instead of a
virtual-host-style URL
endpoint (<bucket>.s3.amazonaws.com ). |
s3BucketEndpoint | string | The URL used to access this AWS S3 or S3-compatible bucket. |
s3BucketName | string | The name of the S3 bucket that hosts the S3 oplog store. |
sseEnabled | boolean |
|
uri | string | A comma-separated list of hosts in the <hostname:port> format
that can be used to access this S3 oplog store. |
ssl | boolean | Flag indicating whether this S3 oplog store only accepts connections encrypted using TLS. |
writeConcern | string | The write concern used for this oplog store.
See also To learn about write acknowledgement levels in MongoDB, see Write Concern |