Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Resources
/
Backup Administration
/
Blockstore

Create One Blockstore Configuration

On this page

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

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 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 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 maximum amount of data in GB this blockstore can store.

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 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.

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

The maximum amount of data in GB this blockstore can store.

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

1curl --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

Next

Update