- API >
- Public API Resources >
- Backup Administration >
- File System Store Configurations >
- Update One File System Store Configuration
Update One File System Store Configuration¶
On this page
Updates the configuration of one file system store.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
FILE-SYSTEM-CONFIG-ID | string | The unique name that labels this file system store configuration. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Indicates whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | 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 For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
Name | Type | Description |
---|---|---|
assignmentEnabled | boolean | Optional. Flag indicating whether this file system store can be assigned backup jobs. |
labels | array of strings | Optional. Array of tags to manage which backup jobs Ops Manager can assign to which file system stores. Setting these tags limits which backup jobs this file system store can process. If omitted, this file system store 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. See also To learn more about Load Factor, see Edit an Existing Blockstore |
mmapv1CompressionSetting | string | The compression setting for the MMAPv1 storage engine snaphots. The accepted values for this option are:
Important MongoDB removed 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 | The location where file system-based backups are stored on the file system store host. |
wtCompressionSetting | string | The compression setting for the WiredTiger storage engine snaphots. The accepted values for this option are:
|
Response¶
Name | Type | Description |
---|---|---|
assignmentEnabled | boolean | Flag indicating whether this file system store can be assigned backup jobs. |
id | string | The unique identifier of this file system store. |
labels | array of strings | Array of tags to manage which backup jobs Ops Manager can assign to which file system stores. |
links | object array | One or more links to sub-resources and/or related resources. The relations 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. See also To learn more about Load Factor, see Edit an Existing Blockstore |
mmapv1CompressionSetting | string | The compression setting for the MMAPv1 storage engine snaphots. The accepted values for this option are:
Important MongoDB removed 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 | The system root-relative directory path where file system-based backups are stored on the file system store host. |
wtCompressionSetting | string | The compression setting for the WiredTiger storage engine snaphots. The accepted values for this option are:
|