Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Create One Sync Store Configuration

On this page

Configures one new sync store.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

Resource

copy 
POST /sync/mongoConfigs

Request Path Parameters

This endpoint does not use HTTP request path parameters.

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:

Name Description
status HTTP response code
envelope Expected response body
false

Request Body Parameters

Name Type Description
assignmentEnabled boolean Optional. Flag indicating whether this sync store can be assigned backup jobs.
encryptedCredentials boolean Optional. 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

Optional. Array of tags to manage which backup jobs Ops Manager can assign to which sync stores.

Setting these tags limits which backup jobs this sync store can process. If omitted, this sync store can only process backup jobs for projects that do not use labels to filter their jobs.
maxCapacityGB number Optional. 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 Optional. Flag indicating whether this sync store only accepts connections encrypted using TLS.
writeConcern string

Optional. The write concern used for this sync store.

The accepted values for this option are:

  • ACKNOWLEDGED
  • W2
  • JOURNALED
  • MAJORITY

See also

To learn about write acknowledgement levels in MongoDB, see Write Concern

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 links arrays in responses include at least one link called self. The relationships 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:

  • ACKNOWLEDGED
  • W2
  • JOURNALED
  • MAJORITY

See also

To learn about write acknowledgement levels in MongoDB, see Write Concern

Example Request

copy 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs?pretty=true' \
     --data '{
       "assignmentEnabled" : true,
       "encryptedCredentials" : false,
       "id" : "{SYNCSTORE-CONFIG-ID}",
       "labels" : [ "l1", "l2" ],
       "maxCapacityGB" : 8,
       "uri" : "mongodb://localhost:27017",
       "ssl" : true,
       "writeConcern" : "W2"
     }'

Example Response

Response Header

HTTP/1.1 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

HTTP/1.1 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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "id" : "{SYNCSTORE-CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs",
    "rel" : "self"
  }],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.