Skip to main content

Get health check details

This endpoint allows you to get information about a health check.

Endpoint

GET /healthcheck/v1/healthchecks/{uuid}

Parameters

NameLocationRequiredTypeDefault valueDescription
uuidURLYesstringThe health check uuid

Responses

A Healthcheck object.

Example Request

GET /healthcheck/v1/healthchecks/38ebd5bb-6a16-44e2-be31-90e1e0250b73

Example Response

{
"message": "OK",
"data": {
"uuid": "38ebd5bb-6a16-44e2-be31-90e1e0250b73",
"name": "Healthcheck",
"status": "HEALTHY",
"customer_id": "10",
"protocol": "HTTPS",
"target": "https://www.nameshield.net",
"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",
"http_server_address": "1.2.3.4",
"verify_ssl": "true"
}
}