Update Health Check Settings
DescriptionSet health settings based on provided healthSpec
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"
Request Body
Request Body
HealthCheckSettingsUpdateSpec of mimetype application/json
Required
This parameter has no documentation
(Both the class referenced by the parameter and parameter itself are missing descriptions)
{
"db_health_check_state_manual_backup": false,
"db_health_check_state_scheduled_backup": false
}
boolean
db_health_check_state_manual_backup
Optional
Health check state of database during manual backup with this option set, the health status of the particular health check will be enabled If unset the current state will remain unchanged.
boolean
db_health_check_state_scheduled_backup
Optional
Health check state of database during schedule backup with this option set, the health status of the particular health check will be enabled If unset the current state will remain unchanged.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : The request cannot be fulfilled due to bad syntax.
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
$HealthCheckSettingsUpdateSpec = Initialize-HealthCheckSettingsUpdateSpec -DbHealthCheckStateManualBackup $false -DbHealthCheckStateScheduledBackup $false
Invoke-UpdateHealthSettings -HealthCheckSettingsUpdateSpec $HealthCheckSettingsUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"db_health_check_state_manual_backup":false,"db_health_check_state_scheduled_backup":false}' https://{api_host}/api/appliance/health/settings
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update
Availability
Added in 7.0.0.1
