- API >
- Public API Resources >
- Backup Administration >
- File System Store Configurations >
- Get All File System Store Configurations
Get All File System Store Configurations¶
On this page
Retrieves the configurations of all file system stores.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource¶
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
Request Query Parameters¶
Name | Type | Description | Default |
---|---|---|---|
pageNum | integer | Page number (1-based). | 1 |
itemsPerPage | integer | Maximum number of items to return, up to a maximum of 100. | 100 |
pretty | boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
envelope | boolean | Flag indicating 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 a list of results, the |
false |
assignableOnly | boolean | Flag indicating whether this file system store can be assigned new backup jobs. | true |
---|
Request Body Parameters¶
This endpoint does not 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 | object array | This array includes one object for each item detailed in the results Embedded Document section. |
links | object array | This 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 | The 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 file system store.
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:
|
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:
|