Get Health Check Settings
Get health settings for vCenter Server.
Request
URLURL
https://{api_host}/api/appliance/health/settings
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
HealthCheckSettingsSettingSpec
of type application/json
health settings.
{
"db_health_check_state_manual_backup": false,
"db_health_check_state_scheduled_backup": false
}
boolean
db_health_check_state_manual_backup
Required
Health check state of database during manual backup with this option set, the health status of the particular health check will be reported
boolean
db_health_check_state_scheduled_backup
Required
Health check state of database during schedule backup with this option set, the health status of the particular health check will be reported
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetHealthSettings
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/health/settings
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.1
