Skip to main content

List health check alerts

This endpoint allows you to list all the alerts of a health check.

Endpoint​

GET /healthcheck/v1/healthchecks/{uuid}/alerts

Parameters​

NameLocationRequiredTypeDefault valueDescription
uuidURLYesstringThe health check uuid

Response​

A list of healthcheckAlert.

Example Request​

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

Example Response​

{
    "message": "OK",
    "data": [
        {
            "id": "10",
            "type": "EMAIL",
            "recipients": [
                "contact@nameshield.com",
                "tech@nameshield.com"
            ],
            "created_at": "2024-07-29T15:51:28.071Z",
            "created_by": "DOE John",
            "modified_at": "2024-07-29T15:51:28.071Z",
            "modified_by": "DOE John"
        }
    ]
}