- API >
- Public API Resources >
- Backup and Restore >
- S3 Oplog Configurations >
- Get All S3 Oplog Configurations
Get All S3 Oplog Configurations¶
On this page
Retrieves the configurations of all s3 oplog stores.
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 | Necessity | Description | Default |
---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. | 1 |
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. | 100 |
pretty | boolean | Optional | Flag that indicates 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 For endpoints that return a list of results, the |
false |
assignableOnly | boolean | Flag indicating whether this S3 oplog store 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 |
array | Array includes one object for each item detailed in the results Embedded Document section. |
links |
array | 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 |
number | 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 oplog store.
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 |