- API >
- Public API Resources >
- Backup Administration >
- Project Backup Job Configurations >
- Get All Project Backup Jobs Configurations
Get All Project Backup Jobs Configurations¶
On this page
Retrieves the configurations of all project’s backup jobss.
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¶
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 |
---|---|---|---|
pageNum | integer | Page number (1-based). | 1 |
itemsPerPage | integer | Maximum number of items to return, up to a maximum of 100. | 100 |
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 a list of results, the |
false |
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 |
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 project’s backup jobs.
Name | Type | Description |
---|---|---|
daemonFilter | object array | An array of pairs of Backup Daemon hosts and their head directories that to which this project’s backup jobs are limited. |
daemonFilter.{#}.headRootDirectory | string | The root-relative path of the head directory on this Backup Daemon host. |
daemonFilter.{#}.machine | string | The host address for one Backup Daemon host. |
id | string | The unique identifier that represents this project’s backup jobs configuration. |
kmipClientCertPassword | string | The password that encrypts the KMIP client certificate. |
kmipClientCertPath | string | The path to the directory on the Backup Daemon host that stores the KMIP client certificate. |
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 |
labelFilter | array of strings | An array of tags that limits which Backup Daemons and snapshot stores can process backup jobs for this project. |
oplogStoreFilter | array of strings | An array of unique identifiers representing oplog stores that can be used with this project’s backup jobs. If omitted, all available oplog stores are used. |
snapshotStoreFilter | object array | Array of unique identifiers representing specific snapshot stores and their types that can be used with this project’s backup jobs. If omitted, all available snapshot stores are used. |
snapshotStoreFilter.{#}.id | string | The unique identifier representing specific snapshot stores that can be used with this project’s backup jobs. |
snapshotStoreFilter.{#}.type | string | The type of the specific snapshot store given as
The accepted values for this option are:
|
syncStoreFilter | array of strings | An array of sync store filters that can be used with this project’s backup jobs. If omitted, all available sync stores are used. |