Skip to main content
Healthchecks are the platform’s own view of whether an organization’s pipeline is working: are detections still returning results, is the review queue piling up, are takedowns stuck. Each one returns a uniform shape — id, severity, observed, threshold, findings, suggestedAction — so a script can treat them all the same way.

healthchecks list

List every healthcheck the platform exposes, including ones that are defined but not yet implemented on the backend. Not-yet-implemented entries carry a notImplementedReason you can surface to users.
Implemented checks at the time of writing: Run healthchecks list for the live set rather than trusting this table — it is the authority, and it grows.

healthchecks run

Run a single check by ID, or --all to run every implemented check in parallel and aggregate the results.
A breached threshold exits with code 6 — the check ran, and something is unhealthy. That is a failing gate rather than an error to retry:

healthchecks vs. detections healthcheck

detections healthcheck is detection-specific and can run the configs before validating them. healthchecks run covers the whole pipeline — reviewing, takedowns, and assets as well — through the public healthchecks API.