Skip to main content

Update a health check

This endpoint allows you to update a health check.

Endpoint

PUT /healthcheck/v1/healthchecks/{uuid}

Parameters

NameLocationRequiredTypeDefault valueDescription
uuidURLYesstringThe health check uuid
BodyYesInputHealthcheckThe health check

Response

The updated Healthcheck object.

Example Request

PUT /healthcheck/v1/healthchecks/38ebd5bb-6a16-44e2-be31-90e1e0250b73
Content-Type: application/json
Body
{
"name": "Healthcheck",
"customer_id": 10,
"protocol": "TCP",
"target": "1.2.3.5",
"port": 443,
"frequency": 30
}

Example Response

{
"message": "OK",
"data": {
"uuid": "38ebd5bb-6a16-44e2-be31-90e1e0250b73",
"name": "Healthcheck",
"status": "HEALTHY",
"customer_id": 10,
"protocol": "TCP",
"target": "1.2.3.5",
"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"
}
}