List site health checks | Modular DS

{
  "data": [
    {
      "attributes": {
        "category": "security",
        "created_at": "2026-09-10T06:00:00.000000Z",
        "description": "One or more installed plugins or themes have a known vulnerability.",
        "effective_status": "critical",
        "ignored_at": null,
        "label": "Vulnerabilities detected",
        "status": "critical",
        "type": "vulnerabilities_detected",
        "updated_at": "2026-09-17T06:00:00.000000Z"
      },
      "id": "1",
      "type": "site-health-checks"
    },
    {
      "attributes": {
        "category": "performance",
        "created_at": "2026-09-10T06:00:00.000000Z",
        "description": "Update PHP to the latest supported version for better performance and security.",
        "effective_status": "good",
        "ignored_at": "2026-09-11T08:00:00.000000Z",
        "label": "PHP version is not the latest",
        "status": "recommended",
        "type": "php_version",
        "updated_at": "2026-09-11T08:00:00.000000Z"
      },
      "id": "2",
      "type": "site-health-checks"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/sites/30/health?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/sites/30/health?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 2
  }
}

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

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

sitestringRequired

Query parameters

filter[status][]stringOptional

good | recommended | critical (repeatable)

filter[category][]stringOptional

performance | security (repeatable)

filter[type][]stringOptional

Check type, e.g. php_version, has_ssl, wordpress_version, memory_limit, vulnerabilities_detected, pseudo_cron (repeatable)

filter[ignored]stringOptional

1|0 — 1 = only the checks you muted, 0 = only the ones still counting; omit for both

sortstringOptional

status, type, created_at; prefix with - to invert. Default: -status (worst first)

page[number]stringOptional

page[size]stringOptional

Max 50

Response

200 - Health checks

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

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.