Docs Menu

Docs HomeMongoDB Ops Manager

Get All File System Store 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

Retrieves the configurations of all file system stores.

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

GET /snapshot/fileSystemConfigs

This endpoint doesn't use HTTP request path 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
Optional
Flag that indicates whether this file system store can be assigned new backup jobs.
true

This endpoint doesn't use HTTP request body parameters.

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.

Each result is one file system store.

Name
Type
Description
assignmentEnabled
boolean
Flag that indicates whether this file system store can be assigned backup jobs.
id
string
Unique identifier of this file system store.
labels
array of strings
Tags that manage which backup jobs Ops Manager can assign to which file system stores.
links
array of objects

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

Positive, non-zero integer that expresses how much backup work this snapshot store should perform compared to another snapshot store. Set this option only if you're using more than one snapshot store.

Tip

See also:

To learn more about Load Factor, see Edit an Existing Blockstore

mmapv1CompressionSetting
string

Compression setting if you use the MMAPv1 storage engine for your snaphots.

Ops Manager may return NONE or GZIP.

If the MongoDB runs FCV 4.2 or later, Ops Manager ignores this setting.

Important

MongoDB removed support for the MMAPv1 storage engine in MongoDB 4.2. If you edit your deployment's configuration to change your storage engine to WiredTiger Storage Engine, Ops Manager restarts the MongoDB processes.

storePath
string
System root-relative directory path where file system-based backups are stored on the file system store host.
wtCompressionSetting
string

Compression setting if you use the WiredTiger storage engine for your snaphots.

Ops Manager may return NONE or GZIP.

If the MongoDB runs FCV 4.2 or later, Ops Manager ignores this setting.

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/fileSystemConfigs?pretty=true'
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}
1{
2 "links" : [ {
3 "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs?pretty=true&pageNum=1&itemsPerPage=100",
4 "rel" : "self"
5 } ],
6 "results" : [ {
7 "assignmentEnabled" : true,
8 "id" : "{FILE-SYSTEM-STORE-CONFIG-ID}",
9 "labels" : [ "l1", "l2" ],
10 "links" : [ {
11 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILESYSTEM-ID}",
12 "rel" : "self"
13 }],
14 "loadFactor" : 50,
15 "mmapv1CompressionSetting" : "NONE",
16 "storePath" : "/data/backup",
17 "wtCompressionSetting" : "GZIP"
18 } ],
19 "totalCount" : 1
20}
←  Get One File System Store Configuration by IDCreate One File System Store Configuration →