Liveness API

Configure liveness monitoring probes, retrieve test results, daily statistics, and current uptime status.

GET/api/v1/livenessAuth required

List all liveness monitoring configurations.

Query Parameters

Parameter	Type	Required	Description
endpoint_id	string	No	Filter by endpoint UUID
domain_id	string	No	Filter by domain UUID
is_enabled	boolean	No	Filter by enabled state
limit	number	No	Max results, default 50
offset	number	No	Pagination offset, default 0

Response

json

{
  "configs": [
    {
      "id": "uuid",
      "endpoint_id": "uuid",
      "is_enabled": true,
      "timeout_seconds": 30,
      "created_at": "2026-01-01T00:00:00Z"
    }
  ],
  "total": 1
}

GET/api/v1/liveness/:idAuth required

Get a single liveness configuration by UUID.

Response

json

{
  "id": "uuid",
  "endpoint_id": "uuid",
  "endpoint_url": "https://example.com",
  "is_enabled": true,
  "timeout_seconds": 30,
  "created_at": "2026-01-01T00:00:00Z"
}

POST/api/v1/livenessAuth required

Create a liveness monitoring configuration for an endpoint.

Request Body

Parameter	Type	Required	Description
endpoint_id	string	Yes	UUID of the endpoint to monitor
is_enabled	boolean	No	Enable monitoring immediately, default true
timeout_seconds	number	No	Probe timeout in seconds, default 30

Response

json

{
  "id": "uuid",
  "endpoint_id": "uuid",
  "is_enabled": true,
  "timeout_seconds": 30,
  "created_at": "2026-03-28T09:00:00Z"
}

Error Codes

Status	Description
409	Liveness config already exists for this endpoint

PUT/api/v1/liveness/:idAuth required

Update a liveness configuration.

Request Body

Parameter	Type	Required	Description
is_enabled	boolean	No	Enable or disable probing
timeout_seconds	number	No	Update probe timeout

Response

json

{
  "id": "uuid",
  "is_enabled": false,
  "timeout_seconds": 60,
  "updated_at": "2026-03-28T09:00:00Z"
}

DELETE/api/v1/liveness/:idAuth required

Delete a liveness configuration and all associated test result history.

Response

json

{
  "message": "Liveness config deleted",
  "deleted_id": "uuid"
}

GET/api/v1/liveness/:id/resultsAuth required

Get individual probe test results for a liveness configuration.

Query Parameters

Parameter	Type	Required	Description
limit	number	No	Max results, default 50
offset	number	No	Pagination offset, default 0
hours	number	No	Hours of history to return, default 24

Response

json

{
  "results": [
    {
      "timestamp": "2026-03-28T09:00:00Z",
      "is_successful": true,
      "response_time_ms": 145,
      "status_code": 200
    }
  ],
  "total": 144
}

GET/api/v1/liveness/:id/statsAuth required

Get daily aggregated statistics for a liveness configuration.

Query Parameters

Parameter	Type	Required	Description
days	number	No	Number of days of history, default 30

Response

json

{
  "stats": [
    {
      "date": "2026-03-28",
      "total_tests": 144,
      "successful_tests": 143,
      "success_rate": 99.3,
      "avg_response_time_ms": 152
    }
  ]
}

GET/api/v1/liveness/:id/statusAuth required

Get the current uptime status for a liveness configuration.

Response

json

{
  "status": "up",
  "uptime_24h": 99.8,
  "uptime_7d": 99.5,
  "avg_response_time_ms": 148,
  "consecutive_failures": 0
}