Skip to main content

Health API

Monitor system health and configure heartbeat schedules.

Health check

No authentication required. Returns system health metrics including CPU and memory usage.

Response

The health field reflects overall system status:

Error response

When the system is unhealthy, the response body uses status: "error" rather than a top-level error field:

Get heartbeat settings

Requires session authentication.

Response

Update heartbeat settings

Requires session authentication.

Request body

Response

Delete heartbeat settings

Requires session authentication. Resets heartbeat configuration to defaults.

Response