REST API - update

appliance health check settings: update

Set health settings based on provided healthSpec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

PATCH https://{server}/rest/appliance/health/settings

Request Body Structure:

{
    "health_settings"{
        "db_health_check_state_scheduled_backup"true,
        "db_health_check_state_manual_backup"true
    }
}

Request Body Parameters:

Name Type Description
bold = required
health_settings update_spec
health_settings.db_health_check_state_manual_backup boolean Health check state of database during manual backup with this option set, the health status of the particular health check will be enabled. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset the current state will remain unchanged.

health_settings.db_health_check_state_scheduled_backup boolean Health check state of database during schedule backup with this option set, the health status of the particular health check will be enabled. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset the current state will remain unchanged.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error Generic error.
400 invalid_argument