Skip to main content

Create a health check alert

Create a new health check alert.

Endpoint

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

Parameters

NameLocationRequiredTypeDefault valueDescription
uuidURLYesstringThe health check uuid
BodyYesInputHealthcheckAlertThe health check alert

Response

The created HealthcheckAlert object.

Example Request

POST /healthcheck/v1/healthchecks/38ebd5bb-6a16-44e2-be31-90e1e0250b73/alerts
Content-Type: application/json
Body
{
"type": "EMAIL",
"recipients": [
"contact@nameshield.com",
"tech@nameshield.com"
]
}

Example Response

200 Create health check alert
{
"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"
}
}