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
GET /sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}
Request Path Parameters
Name | Type | Description |
|---|---|---|
SYNC-STORE-CONFIG-ID | string | The unique identifier that represents this Oplog configuration. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating 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 envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters
This endpoint doesn't 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. All
|
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:
To learn about write acknowledgement levels in MongoDB, see Write Concern. |
Example Request
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}?pretty=true'
Example Response
Response Header
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Response Body
{ "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNC-STORE-CONFIG-ID}", "rel" : "self" }], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2" }