List a website's site health checks

GET

https://api.modulards.com/api/public/v1/sites/:site/health

GET

/api/public/v1/sites/:site/health

curl https://api.modulards.com/api/public/v1/sites/site/health \
     -H "Authorization: Bearer <token>"

200200 - Health checks

{
  "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,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/sites/30/health?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/sites/30/health",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Lists the site health checks reported for one website. Use it to see what needs attention on a website, for example with filter[status][]=critical to list only the critical checks.

Each check is in the performance or security category and has a status of good, recommended or critical. A check you muted keeps its status but counts one level milder. The worst checks come first unless you sort otherwise.

Refreshing the checks and muting or unmuting one are done from the dashboard. Your role must be allowed to see health checks; without it the request answers 404.

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

Only checks with these statuses: good, recommended or critical. Several values match any of them.

filter[category][]stringOptional

Only checks of these categories: performance or security. Several values match any of them.

filter[type][]stringOptional

Only these kinds of check, for example php_version, wordpress_version, has_ssl, memory_limit, vulnerabilities_detected or pseudo_cron. Several values match any of them.

filter[ignored]stringOptional

1 for only the checks you muted, 0 for only the ones that still count. Omit it to get both.

sortstringOptional

Sort order. Accepted: status, type, created_at; a leading - reverses the order. Default -status, the worst checks first (plain status lists the best first).

page[number]stringOptional

Page number, starting at 1.

page[size]stringOptional

Rows per page, up to 50 (default 15).

Response

200 - Health checks

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional