Update One Oplog Configuration

On this page

Resource

Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Example Request
Example Response
Response Header
Response Body

Updates the configuration of one oplog store.

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

Resource

PUT /oplog/mongoConfigs/{OPLOG-CONFIG-ID}

Request Path Parameters

Name	Type	Description
OPLOG-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:

Name	Description
`status`	HTTP response code
`content`	Expected response body

false

Request Body Parameters

Name	Type	Description
assignmentEnabled	boolean	Optional. Flag indicating whether this oplog store can be assigned backup jobs.
encryptedCredentials	boolean	Optional. Flag indicating whether the username and password for this oplog store were encrypted using the credentialstool.
labels	array of strings	Optional. Array of tags to manage which backup jobs Ops Manager can assign to which oplog stores. Setting these tags limits which backup jobs this oplog store can process. If omitted, this oplog 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 oplog store can store.
uri	string	A comma-separated list of hosts in the `<hostname:port>` format that can be used to access this oplog store.
ssl	boolean	Optional. Flag indicating whether this oplog store only accepts connections encrypted using TLS.
writeConcern	string	Optional. The write concern used for this oplog store. The accepted values for this option are: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` To learn about write acknowledgement levels in MongoDB, see Write Concern.

Response

Name	Type	Description
assignmentEnabled	boolean	Flag indicating whether this oplog store can be assigned backup jobs.
encryptedCredentials	boolean	Flag indicating whether the username and password for this oplog store were encrypted using the credentialstool.
id	string	The unique name that labels this oplog store.
labels	array of strings	Array of tags to manage which backup jobs Ops Manager can assign to which 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.
maxCapacityGB	number	The maximum amount of data in GB this oplog store can store.
uri	string	A comma-separated list of hosts in the `<hostname:port>` format that can be used to access this oplog store.
ssl	boolean	Flag indicating whether this oplog 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 oplog store. The accepted values for this option are: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` To learn about write acknowledgement levels in MongoDB, see Write Concern.

Example Request

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}?pretty=true' \
 --data '{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "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

{
  "assignmentEnabled" : true,
  "encryptedCredentials" : false,
  "id" : "{CONFIG-ID}",
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}",
    "rel" : "self"
  }],
  "maxCapacityGB" : 8,
  "uri" : "mongodb://localhost:27017",
  "ssl" : true,
  "usedSize" : 222,
  "writeConcern" : "W2"
}

Back

Create

Delete