Get All Blockstore Configurations

On this page

Resource

Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Response Document
results Embedded Document
Example Request
Example Response
Response Header
Response Body

Ops Manager v6.0 will EOL in January 2025. Upgrade to a higher Ops Manager version as soon as possible.

Retrieves the configurations of all blockstores.

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

Resource

GET /snapshot/mongoConfigs

Request Path Parameters

This endpoint doesn't use HTTP request path parameters.

Request Query Parameters

Name	Type	Necessity	Description	Default
pageNum	number	Optional	One-based integer that returns a subsection of results.	`1`
itemsPerPage	number	Optional	Number of items to return per page, up to a maximum of 500.	`100`
pretty	boolean	Optional	Flag that indicates 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 a list of results, the `results` object is an envelope. Ops Manager adds the `status` field to the response body.	`false`
backupJobsEnabledOnly	boolean	Optional	Flag indicating whether to exclude daemons not enabled for backing up databases from the response. Set this to `false` to include daemon configurations with the `backupJobsEnabled` flag set to `false`.	`true`

assignableOnly	boolean	Flag indicating whether this blockstore can be assigned new backup jobs.	`true`

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name	Type	Description
`results`	array	Array includes one object for each item detailed in the `results` Embedded Document section.
`links`	array	Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
`totalCount`	number	Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

`results` Embedded Document

Each result is one blockstore.

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

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true'

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

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "assignmentEnabled" : true,
    "encryptedCredentials" : false,
    "id" : "{BLOCKSTORE-CONFIG-ID}",
    "labels" : [ "l1", "l2" ],
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-CONFIG-ID}",
      "rel" : "self"
    }],
    "loadFactor" : 2,
    "maxCapacityGB" : 8,
    "uri" : "mongodb://localhost:27017",
    "ssl" : true,
    "usedSize" : 222,
    "writeConcern" : "W2"
  } ],
  "totalCount" : 1
}

Back

Get One Blockstore Configuration by ID

Create One Blockstore Configuration