Cosmic Admin API Reference

updateLBHealthCheckPolicy

Updates load balancer health check policy

Request parameters

Parameter NameDescriptionRequired
idID of load balancer health check policytrue
customidan optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayan optional field, whether to the display the policy to the end user or notfalse

Response Tags

Response NameDescription
accountthe account of the HealthCheck policy
domainthe domain of the HealthCheck policy
domainidthe domain ID of the HealthCheck policy
lbruleidthe LB rule ID
zoneidthe id of the zone the HealthCheck policy belongs to
healthcheckpolicy(*)the list of healthcheckpolicies
idthe LB HealthCheck policy ID
descriptionthe description of the healthcheck policy
fordisplayis policy for display to the regular user
healthcheckintervalAmount of time between health checks
healthcheckthressholdNumber of consecutive health check success before declaring an instance healthy
pingpaththe pingpath of the healthcheck policy
responsetimeTime to wait when receiving a response from the health check
statethe state of the policy
unhealthcheckthressholdNumber of consecutive health check failures before declaring an instance unhealthy.