You were redirected from a different version of the documentation. Click here to go back.

Get One File System Store Configuration by ID

Retrieves the configuration of one file system store.

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


GET /snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}

Request Path Parameters

Path Parameter Type Necessity Description
FILE-SYSTEM-CONFIG-ID string Required Unique name that labels this file system store configuration.

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
envelope Expected response body

Request Body Parameters

This endpoint doesn’t use HTTP request body parameters.


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.

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.


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.

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/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}?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

  "assignmentEnabled" : true,
  "labels" : [ "l1", "l2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/fileSystemConfigs/{FILE-SYSTEM-CONFIG-ID}",
    "rel" : "self"
  "loadFactor" : 50,
  "mmapv1CompressionSetting" : "NONE",
  "storePath" : "/data/backup",
  "wtCompressionSetting" : "GZIP"