List health checks

This endpoint allows you to list the health checks.
Many results can be returned, so a pagination system is provided with the limit and offset parameters.
You can also use filters to search for specific health checks.

Endpoint

GET /healthcheck/v1/healthchecks

Parameters

Name	Location	Required	Type	Default value	Description
limit	URL	No	integer		Number of health checks to return (max 500)
offset	URL	No	integer		Offset used
sort	URL	No	string		Field used to sort health checks. Allowed values : name, uuid
name	URL	No	string		Search by health check name. Wildcard compatible
status	URL	No	string		Search by health check status 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.
protocol	URL	No	string		Search by health check protocol 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. Wildcard compatible
target	URL	No	string		Search by the target name. Wildcard compatible
customer_id	URL	No	integer		Search by customer ID
include_subsidiaries	URL	No	boolean		Include subsidiaries in the search

Responses

A HealthcheckSearchResults object.

Example Request

GET /healthcheck/v1/healthchecks?limit=2&offset=2&name=healthcheck&status=HEALTHY

Example Response

{
    "message": "OK",
    "data": {
        "total": "100",
        "limit": "2",
        "offset": "2",
        "results": [
            {
                "uuid": "38ebd5bb-6a16-44e2-be31-90e1e0250b73",
                "name": "Healthcheck",
                "status": "HEALTHY",
                "customer_id": "10",
                "protocol": "TCP",
                "target": "1.2.3.4",
                "port": "443",
                "frequency": "30",
                "created_at": "2024-07-29T15:51:28.071Z",
                "created_by": "DOE John",
                "modified_at": "2024-07-29T15:51:28.071Z",
                "modified_by": "DOE John"
            }
        ]
    }
}