JSON objects

Response objects

Healthcheck

Name	Type	Default value	Description
uuid	String		The health check uuid
name	String		The name of the health check
status	String		The status of the health check Allowed values : INSTALLING: The probes are currently determining the initial status of the health check. During this process, the status is considered HEALTHY HEALTHY: The majority of probes are able to establish a connection with the endpoint UNHEALTHY: The majority of probes are unable to establish a connection with the endpoint
customer_id	Integer		The customer ID associated with the health check
protocol	String		The protocol used by the health check Allowed values : TCP: The probes try to establish a TCP connection HTTP: The probes submit an HTTP request and wait for an HTTP status code of 2xx HTTPS: The probes submit an HTTPS request and wait for an HTTP status code of 2xx. By default, the certificate validity is not verified
target	String		The target of the health check. You can specify the target using an IP address (IPV4, IPV6), a domain or a specific URL
port	Integer		The port used to establish the connection
frequency	Integer		Time interval (in seconds) between checks
created_at	String (date-time)		The creation date of the health check
created_by	String		The user who created the health check
modified_at	String (date-time)		The last modification date of the health check
modified_by	String		The last user who modified the health check
http_server_address	String		IP address used to establish the connection. Available only for HTTP and HTTPS health checks. By default, the IP address is obtained by resolving the domain specified in the target field
verify_ssl	Boolean		Enable the verification of the SSL/TLS certificate validity. Available only for HTTPS health checks

HealthcheckAlert

Name	Type	Default value	Description
id	Integer		The alert ID
type	String		Type of alert. Allowed values : EMAIL
recipients	Array		List of alert recipients
created_at	String (date-time)		The creation date of the alert
created_by	String		The user who created the alert
modified_at	String (date-time)		The last modification date of the alert
modified_by	String		The last user who modified the alert

HealthcheckSearchResults

Name	Type	Default value	Description
total	Integer		Total number of health checks matching the search criteria
limit	Integer	100	Number of health checks returned
offset	Integer	0	Offset used
results	List of Healthcheck		List of health checks matching the search criteria

Input objects

InputHealthcheck

Name	Type	Default value	Description
name	String		The name of the health check
customer_id	Integer		The customer ID associated with the health check
protocol	String		The protocol used by the health check Allowed values : TCP: The probes try to establish a TCP connection HTTP: The probes submit an HTTP request and wait for an HTTP status code of 2xx HTTPS: The probes submit an HTTPS request and wait for an HTTP status code of 2xx. By default, the certificate validity is not verified
target	String		The target of the health check. You can specify the target using an IP address (IPV4, IPV6), a domain or a specific URL
port	Integer		The port used to establish the connection
frequency	Integer		Time interval (in seconds) between checks
http_server_address	String		IP address used to establish the connection. Available only for HTTP and HTTPS health checks. By default, the IP address is obtained by resolving the domain specified in the target field
verify_ssl	Boolean		Enable the verification of the SSL/TLS certificate validity. Available only for HTTPS health checks

InputHealthcheckAlert

Name	Required	Type	Default value	Description
type	Yes	String		Type of alert. Allowed values : EMAIL
recipients	Yes	Array		List of alert recipients