- API >
- Public API Resources >
- Backup Administration >
- Project Backup Job Configurations >
- Update One Project Backup Jobs Configuration
Update One Project Backup Jobs Configuration¶
On this page
Updates the configuration of one project’s backup jobs.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
BACKUP-GROUP-ID | string | The unique identifier that represents this backup group. |
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 | 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 one result, response body includes:
|
false |
Request Body Parameters¶
Name | Type | Description |
---|---|---|
daemonFilter | object array | Optional. An array of pairs of Backup Daemon hosts and their head directories that to which this project’s backup jobs are limited. If omitted, all available Backup Daemons are used. |
daemonFilter.{#}.headRootDirectory | string | Optional. The root-relative path of the head directory on this Backup Daemon host. |
daemonFilter.{#}.machine | string | The host address for one Backup Daemon host. |
kmipClientCertPassword | string | Optional. The password that encrypts the KMIP client certificate. |
kmipClientCertPath | string | Optional. The root-relative path on the Backup Daemon host that stores the KMIP client certificate. |
labelFilter | array of strings | Optional. An array of tags that limits which Backup Daemons and snapshot stores can process backup jobs for this project. If a snapshot store or any Backup Daemon has the same If omitted, the project’s backup jobs can use any available Backup Daemon or snapshot store. |
oplogStoreFilter | array of strings | Optional. An array of unique identifiers representing oplog store that can be used with this project’s backup jobs. If omitted, all available oplog stores are used. |
snapshotStoreFilter | object array | Optional. 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 | Optional. The unique identifier representing specific snapshot stores that can be used with this project’s backup jobs. |
snapshotStoreFilter.{#}.type | string | Optional. The type of the specific snapshot store given as
The accepted values for this option are:
|
syncStoreFilter | array of strings | Optional. An array of sync store filters that can be used with this project’s backup jobs. If omitted, all available sync stores are used. |
Response¶
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 store 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. |