- API >
- Public API Resources >
- Backup Administration >
- S3 Blockstore Configurations >
- Get All S3 Blockstore Configurations
Get All S3 Blockstore Configurations¶
On this page
Retrieves the configurations of all s3 blockstores.
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¶
Name | Type | Description | Default |
---|---|---|---|
pageNum | integer | Page number (1-based). | 1 |
itemsPerPage | integer | Maximum number of items to return, up to a maximum of 100. | 100 |
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 a list of results, the |
false |
assignableOnly | boolean | Flag indicating whether this S3 blockstore can be assigned new backup jobs. | true |
---|
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results |
object array | This array includes one object for each item detailed in the results Embedded Document section. |
links |
object array | This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount |
integer | Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results Embedded Document¶
Each result is one S3 blockstore.
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 |