Get One Oplog Configuration by ID

Retrieves the configuration of one oplog store.

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

Resource

GET /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 is in a prettyprint format.	`false`
envelope	boolean	Optional	Flag that indicates whether 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: `status`: HTTP response code `content`: Expected response body	`false`

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

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 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	Optional. The oplog store’s expected maximum available capacity for use in the OUTSIDE_SPACE_USED_THRESHOLD alert. `maxCapacityGB` does not enforce any limitation on the size of the backing database.
oidc	object	OIDC authentication settings for this store. The `oidc` object contains the following fields: `enabled`: boolean. Indicates whether OIDC authentication is enabled for this store. `method`: string. One of `callback`, `azure`, `gcp`, or `k8s`. `tokenUri`: string. The IdP token endpoint. Present only when `method` is `callback`. `clientId`: string. The client ID registered with the IdP. `clientSecret`: string. Ops Manager redacts this value in the response and does not return the raw client secret. `scope`: string. The OAuth2 scope requested from the IdP. Present only when `method` is `callback`. `tokenResource`: string. The audience or resource identifier for the workload identity token. Present only when `method` is `azure` or `gcp`.
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' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/mongoConfigs/{OPLOG-CONFIG-ID}?pretty=true'

Example Response

Response Header

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive

HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-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

Oplog Store

Get All