- API >
- Public API Resources >
- Backup Administration >
- S3 Blockstore Configurations >
- Create One S3 Blockstore Configuration
Create One S3 Blockstore Configuration¶
On this page
Configures one new s3 blockstore.
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¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Indicates whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | 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 For endpoints that return one result, the response body includes:
|
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. If this is
false , the request results in an error and Ops Manager doesn’t
create the S3-compatible store. |
assignmentEnabled | boolean | Optional | Flag that indicates whether you can assign backup jobs to this data store. |
awsAccessKey | string | Required | AWS Access Key ID that can access the S3 bucket specified in
<s3BucketName> . |
awsSecretKey | string | Required | AWS Secret Access Key that can access the S3 bucket
specified in <s3BucketName> . |
encryptedCredentials | boolean | Optional | Flag that indicates whether the username and password for this S3 blockstore were encrypted using the credentialstool. |
id | string | Required | Unique name that labels this S3 Snapshot Store. |
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.
To review the S3 bucket URL conventions, see the AWS S3 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 | integer | Required | Positive integer indicating the maximum number of connections to this S3 blockstore. |
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. Accepted values for this option are:
See also To learn about write acknowledgement levels in MongoDB, see Write Concern |
Response¶
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> . |
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.
|
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. |
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:
See also To learn about write acknowledgement levels in MongoDB, see Write Concern |