Monitor any JSON API in Checkmk without writing a line of code.
Point it at a /health, /status, or metrics endpoint, pick the fields you care
about, and get a Checkmk service for each โ thresholds, graphs, and alerts
included. One rule. Any API. Done.
Generic JSON API
What you get
- ๐ฏ Any endpoint, unmodified โ Spring Boot, Kubernetes, vendor appliances,
your own apps. No special response format required.
- ๐งญ Pick fields by path โ
components.db.status, items[0].count, done.
- ๐ Auto-discover arrays and objects โ
nodes[*].status becomes one
service per array element, and components[*].status one per object key
(e.g. a Spring Boot Actuator /health map), automatically.
- ๐ข Count elements โ flip a switch to monitor how many elements a path
holds (array length or object keys) instead of the value: queue length,
number of unhealthy nodes, ... The count is a number, so units, WARN/CRIT
levels and a metric all apply. Where
[*] fans out one service per element,
count collapses the whole collection into one "how many" service.
- ๐ Many endpoints, one rule โ poll several APIs together, each with its own
method, auth, and fields; an unreachable one only affects its own services.
- ๐ Thresholds & graphs in Checkmk โ WARN/CRIT and metrics live in your
rule, not upstream in the API.
- ๐งฎ Transform the numeric value โ apply a small arithmetic expression like
value / 1024 / 1024 (bytesโMiB) or (value - 32) * 5 / 9 (ยฐFโยฐC) before
levels and the metric; safely evaluated, no eval.
- ๐ค String matching, two ways โ require a value to match a regex (pick the
state when it doesn't, default CRIT), or map values like
ready / degraded
/ failed straight to OK / WARN / CRIT.
- ๐ Secure by default โ basic or bearer auth via the password store, TLS
verification on.
- ๐งฐ Bonus field picker โ paste your JSON in the bundled explorer, click what
to monitor, copy the ready-made rule. On Checkmk 2.5+, install the optional
companion package Generic JSON API โ Explorer (extra) for a guided in-site
wizard that builds the rule for you from a live API response.
In 30 seconds
GET /actuator/health โ {"status": "UP", "components": {"db": {"status": "UP"}}}
Tick status (expect UP) and components.db.status โ instant services
JSON Health and JSON Database. That's the whole setup.
Details
- Checkmk 2.4+, any edition. Tested on real 2.4 and 2.5 sites.
- Install via
mkp add / mkp enable, or Setup โ Extension packages.
- GPL-2.0-only
Uploaded on: 21 Jul 2026
Downloads: 3
Built on Checkmk version: checkmk-json-agent 0.10.0
Minimum Checkmk version required: 2.4.0
MKP MD5 hash: e123fcfa78a2c4539164d32769fffd08