HealthChecksResource


Create a health check in a load balancer


Some providers only allow a single Health Check for each Load Balancer. AWS creates a default health check and allows multiple health checks.

POST https://example.com/api/cloud/locations/{location}/devices/{device}/loadbalancers/{loadbalancer}/healthchecks

Roles : [ROLE_MANAGE_LOADBALANCERS]

Content-Type : healthcheck Accept : healthcheck

Error Codes

  • LOADBALANCER-1 - The requested load balancer does not exist
  • LOADBALANCER-9 - There is already one health check with the same path and protocol in the load balancer
  • LOCATION-4 - The location does not exist
  • PUBLIC-10 - The enterprise does not have credentials for this provider
  • PUBLIC-9 - Plugin not loaded or not a cloud provider
  • RS-2 - The remote service does not exist

Example

List health checks in a load balancer


GET https://example.com/api/cloud/locations/{location}/devices/{device}/loadbalancers/{loadbalancer}/healthchecks

Roles : [ROLE_MANAGE_LOADBALANCERS]

Accept : healthchecks

Error Codes

  • LOADBALANCER-1 - The requested load balancer does not exist
  • LOCATION-4 - The location does not exist

Example

Delete a health check in a load balancer


Some providers do not allow you to remove Health Checks

DELETE https://example.com/api/cloud/locations/{location}/devices/{device}/loadbalancers/{loadbalancer}/healthchecks/{healthcheck}

Roles : [ROLE_MANAGE_LOADBALANCERS]

Parameter Type Default Value Description
force boolean false If true, deletes without public cloud credentials

Example

Get a health check in a load balancer


GET https://example.com/api/cloud/locations/{location}/devices/{device}/loadbalancers/{loadbalancer}/healthchecks/{healthcheck}

Roles : [ROLE_MANAGE_LOADBALANCERS]

Accept : healthcheck

Error Codes

  • LOADBALANCER-1 - The requested load balancer does not exist
  • LOADBALANCER-10 - The requested health check does not exist in the load balancer
  • LOCATION-4 - The location does not exist

Example

Update a health check in a load balancer


PUT https://example.com/api/cloud/locations/{location}/devices/{device}/loadbalancers/{loadbalancer}/healthchecks/{healthcheck}

Roles : [ROLE_MANAGE_LOADBALANCERS]

Content-Type : healthcheck Accept : healthcheck

Error Codes

  • LOADBALANCER-1 - The requested load balancer does not exist
  • LOADBALANCER-10 - The requested health check does not exist in the load balancer
  • LOCATION-4 - The location does not exist
  • PUBLIC-10 - The enterprise does not have credentials for this provider
  • RS-2 - The remote service does not exist

Example