- API >
- Public API Resources >
- Backup Administration >
- Backup Daemon Configurations >
- Update One Backup Daemon Configuration
Update One Backup Daemon Configuration¶
On this page
Updates the configuration of one backup daemon.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
HOST | string | The hostname of this host that serves the Backup Daemon. |
HEAD-ROOT-DIRECTORY | string | Optional. The root-relative URL-encoded path <https://en.wikipedia.org/wiki/Percent-encoding?oldid=810929127> of the head directory on this Backup Daemon host. May be omitted if the Backup Daemon has not been configured. |
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 |
---|---|---|
assignmentEnabled | boolean | Optional. Flag indicating whether this Backup Daemon can be assigned backup jobs. |
backupJobsEnabled | boolean | Optional. Flag indicating whether this Backup Daemon can be used to backup databases. |
configured | boolean | Optional. Flag indicating whether this Backup Daemon is ready to use. |
garbageCollectionEnabled | boolean | Optional. Flag indicating whether this Backup Daemon has garbage collection set. |
headDiskType | string | Optional. The type of disk used to store the head directory. The accepted values for this option are:
|
labels | array of strings | Optional. Array of tags to manage which backup jobs Ops Manager can assign to which Backup Daemons. Setting these tags limits which backup jobs this Backup Daemon can process. If omitted, this Backup Daemon can only process backup jobs for projects that do not use labels to filter their jobs. |
machine | object | Backup Daemon host and its head directories. |
machine.headRootDirectory | string | Optional. The root-relative URL-encoded path of the head directory on this Backup Daemon host. Note Requests should encode slashes in the URL path. Example For Linux platforms, the head directory would be added in this format: |
machine.machine | string | The hostname or IP address of the Backup Daemon host. |
numWorkers | number | Optional. The number of worker processes that can perform tasks (i.e. backup, restore, or groom) for the Backup Daemon. |
resourceUsageEnabled | boolean | Optional. Flag indicating whether this Backup Daemon has its resource usage monitored. |
restoreJobsEnabled | boolean | Optional. Flag indicating whether this Backup Daemon can be used to restore snapshots. |
restoreQueryableJobsEnabled | boolean | Optional. Flag indicating whether this Backup Daemon can perform queryable restores. |
Response¶
Name | Type | Description |
---|---|---|
assignmentEnabled | boolean | Flag indicating whether this Backup Daemon can be assigned backup jobs. |
backupJobsEnabled | boolean | Flag indicating whether this Backup Daemon can be used to backup databases. |
configured | boolean | Flag indicating whether this Backup Daemon is ready to use. |
garbageCollectionEnabled | boolean | Flag indicating whether this Backup Daemon has garbage collection set. |
headDiskType | string | The type of disk used to store the head directory. The accepted values for this option are:
|
id | string | The unique identifier of this Backup Daemon. |
labels | array of strings | Array of tags to manage which backup jobs Ops Manager can assign to which Backup Daemons. |
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 |
machine | object | Backup Daemon host and its head directories. |
machine.headRootDirectory | string | The root-relative path of the head directory on this Backup Daemon host. |
machine.machine | string | The hostname or IP address of the Backup Daemon host. |
numWorkers | number | The number of worker processes that can perform tasks (i.e. backup, restore, or groom) for the Backup Daemon. |
resourceUsageEnabled | boolean | Flag indicating whether this Backup Daemon has its resource usage monitored. |
restoreJobsEnabled | boolean | Flag indicating whether this Backup Daemon can be used to restore snapshots. |
restoreQueryableJobsEnabled | boolean | Flag indicating whether this Backup Daemon can perform queryable restores. |