Skip to main content

Create a health check

This endpoint allows you to create a new health check.

Endpoint​

POST /healthcheck/v1/healthchecks

Parameters​

NameLocationRequiredTypeDefault valueDescription
BodyYesInputHealthcheckThe health check

Response​

The created Healthcheck object.

Example Request​

POST /healthcheck/v1/healthchecks
Content-Type: application/json
Body
{
    "name": "Healthcheck",
    "customer_id": 10,
    "protocol": "TCP",
    "target": "1.2.3.4",
    "port": 443,
    "frequency": 30
}

Example Response​

{
    "message": "OK",
    "data": {
        "uuid": "38ebd5bb-6a16-44e2-be31-90e1e0250b73",
        "name": "Healthcheck",
        "status": "INSTALLING",
        "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"
    }
}