Docs Home

/ /

Blockstore

Docs Home

/ /

Backup Administration

Backup Administration

Blockstore

Create One Blockstore Configuration

Configures one new blockstore.

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

Resource

POST /snapshot/mongoConfigs

Request Path Parameters

This endpoint doesn't 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 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

Name	Type	Description
assignmentEnabled	boolean	Optional. Flag indicating whether this blockstore can be assigned backup jobs.
encryptedCredentials	boolean	Optional. Flag indicating whether the username and password for this blockstore were encrypted using the credentialstool.
id	string	The unique name that labels this blockstore.
labels	array of strings	Optional. Array of tags to manage which backup jobs Ops Manager can assign to which blockstores. Setting these tags limits which backup jobs this blockstore can process. If omitted, this blockstore can only process backup jobs for projects that do not use labels to filter their jobs.
loadFactor	number	Optional. A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. This option is needed only if more than one snapshot store is in use. To learn more about Load Factor, see Edit One Existing Blockstore.
maxCapacityGB	number	Optional. The blockstore’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	Optional. OIDC authentication settings for this store. The `oidc` object accepts the following fields: `enabled`: boolean. Enables OIDC authentication for this store. `method`: string. One of `callback`, `azure`, `gcp`, or `k8s`. `tokenUri`: string. The IdP token endpoint. Required when `method` is `callback`. `clientId`: string. The client ID registered with the IdP. Required when `method` is `callback`; optional when `method` is `azure`. `clientSecret`: string. The client secret registered with the IdP. Required when `method` is `callback`. If you edit an existing store and omit this field or submit the redacted value returned by a previous `GET` request, Ops Manager preserves the existing secret. `scope`: string. The OAuth2 scope requested from the IdP. Used only when `method` is `callback`. `tokenResource`: string. The audience or resource identifier for the workload identity token. Required when `method` is `azure` or `gcp`. This value must match the `audience` configured for this IdP in the target MongoDB deployment's `oidcIdentityProviders` setting. The `callback`, `azure`, `gcp`, and `k8s` methods do not all require the same fields. The `azure`, `gcp`, and `k8s` methods do not require `clientSecret`. When `oidc.enabled` is `true`, provide only hosts and connection options in the store's `uri` field. Ops Manager ignores any username or password embedded in the URI. To switch a store from OIDC to another authentication mechanism, submit `oidc: {enabled: false}` in the request instead of omitting the `oidc` object.
uri	string	A comma-separated list of hosts in the `<hostname:port>` format that can be used to access this blockstore.
ssl	boolean	Optional. Flag indicating whether this blockstore only accepts connections encrypted using TLS.
writeConcern	string	Optional. The write concern used for this blockstore. 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 blockstore can be assigned backup jobs.
encryptedCredentials	boolean	Flag indicating whether the username and password for this blockstore were encrypted using the credentialstool.
id	string	The unique name that labels this blockstore.
labels	array of strings	Array of tags to manage which backup jobs Ops Manager can assign to which blockstores.
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.
loadFactor	number	A positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. This option is needed only if more than one snapshot store is in use. To learn more about Load Factor, see Edit One Existing Blockstore.
maxCapacityGB	number	Optional. The blockstore’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 blockstore.
ssl	boolean	Flag indicating whether this blockstore 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 blockstore. The accepted values for this option are: `ACKNOWLEDGED` `W2` `JOURNALED` `MAJORITY` To learn about write acknowledgement levels in MongoDB, see Write Concern.

Example Request

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

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

Back

Get All

Update

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