- API >
- Public API Resources >
- Backup Administration >
- Sync Store Configurations >
- Get One Sync Store Configuration by ID
Get One Sync Store Configuration by ID¶
On this page
Retrieves the configuration of one sync store.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
SYNC-STORE-CONFIG-ID | string | The unique identifier that represents this Oplog configuration. |
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¶
This endpoint does not use HTTP request body parameters.
Response¶
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 |