- API >
- Public API Resources >
- Backup Administration >
- Sync Store Configurations >
- Get All Sync Store Configurations
Get All Sync Store Configurations¶
On this page
Retrieves the configurations of all sync 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 | 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 sync 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 |
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 sync store.
Name | Type | Description |
---|---|---|
assignmentEnabled | boolean | Flag indicating whether this sync store can be assigned backup jobs. |
encryptedCredentials | boolean | Flag indicating whether the username and password for this sync store were encrypted using the credentialstool. |
id | string | The unique name that labels this sync store. |
labels | array of strings | Array of tags to manage which backup jobs Ops Manager can assign to which sync stores. |
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 |
maxCapacityGB | number | The maximum amount of data in GB this sync store can store. |
uri | string | A comma-separated list of hosts in the <hostname:port>
format that can be used to access this sync store. |
ssl | boolean | Flag indicating whether this sync store only accepts connections encrypted using TLS. |
usedSize | number | The amount of backup capacity in MB that the existing backups consume. |
writeConcern | string | The write concern used for this sync store. The accepted values for this option are:
See also To learn about write acknowledgement levels in MongoDB, see Write Concern |