> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server. # List site health checks GET https://api.modulards.com/api/public/v1/sites/{site}/health 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. Reference: https://api.docs.modulards.com/modular-ds-public-api/security-health/list-site-health-checks ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Path parameters - `site` (string, required) ### Query parameters - `filter[status][]` (string, optional) — good | recommended | critical (repeatable) - `filter[category][]` (string, optional) — performance | security (repeatable) - `filter[type][]` (string, optional) — Check type, e.g. php_version, has_ssl, wordpress_version, memory_limit, vulnerabilities_detected, pseudo_cron (repeatable) - `filter[ignored]` (string, optional) — 1|0 — 1 = only the checks you muted, 0 = only the ones still counting; omit for both - `sort` (string, optional) — status, type, created_at; prefix with - to invert. Default: -status (worst first) - `page[number]` (string, optional) - `page[size]` (string, optional) — Max 50 ## Response ### 200 200 - Health checks - `data` (list of object, optional) - `attributes` (object, optional) - `category` (string, optional) - `created_at` (string, optional) - `description` (string, optional) - `effective_status` (string, optional) - `ignored_at` (string, optional, nullable) - `label` (string, optional) - `status` (string, optional) - `type` (string, optional) - `updated_at` (string, optional) - `id` (string, optional) - `type` (string, optional) - `jsonapi` (object, optional) - `version` (string, optional) - `links` (object, optional) - `first` (string, optional) - `last` (string, optional) - `next` (any, optional, nullable) - `prev` (any, optional, nullable) - `meta` (object, optional) - `current_page` (double, optional) - `per_page` (double, optional) - `total` (double, optional) ## Examples **Response** ```json { "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 } } ``` **SDK Code** ```python 200 - Health checks import requests url = "https://api.modulards.com/api/public/v1/sites/site/health" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Health checks const url = 'https://api.modulards.com/api/public/v1/sites/site/health'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 - Health checks package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/sites/site/health" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 - Health checks require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/sites/site/health") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - Health checks import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/sites/site/health") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Health checks request('GET', 'https://api.modulards.com/api/public/v1/sites/site/health', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Health checks using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/sites/site/health"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Health checks import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/sites/site/health")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```