List site health checks | Modular DS

Lists one site’s health checks as a JSON:API collection of type site-health-checks, with the usual links / meta pagination.

Each entry carries type, category (performance / security, derived from the type), status (the raw result), effective_status (one level milder when the check is ignored), label, description, ignored_at, created_at and updated_at.

Path variable site is the exact site id (e.g. 12345). Default sort is -status, so the worst checks come first.

Read only: refreshing the checks and muting/unmuting one stay dashboard-only. Sites of other organizations — and members without the health read permission — answer 404; an unknown filter or sort value answers 422. A read-only token is enough. The MCP twin of this endpoint is the sites-health-index tool.

Lists one site's health checks as a JSON:API collection of type `site-health-checks`, with the usual `links` / `meta` pagination. Each entry carries `type`, `category` (`performance` / `security`, derived from the type), `status` (the raw result), `effective_status` (one level milder when the check is ignored), `label`, `description`, `ignored_at`, `created_at` and `updated_at`. Path variable `site` is the exact site id (e.g. `12345`). Default sort is `-status`, so the worst checks come first. Read only: refreshing the checks and muting/unmuting one stay dashboard-only. Sites of other organizations — and members without the health read permission — answer 404; an unknown filter or sort value answers 422. A read-only token is enough. The MCP twin of this endpoint is the `sites-health-index` tool.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sitestringRequired

Response

Successful response

Lists one site’s health checks as a JSON:API collection of type site-health-checks, with the usual links / meta pagination.

Path variable site is the exact site id (e.g. 12345). Default sort is -status, so the worst checks come first.