Home

checkmk-json-agent Wiki

A generic Checkmk special agent for monitoring any HTTP/JSON API. Point it at a /health or /status endpoint, extract fields by path, and turn them into Checkmk services with thresholds, metrics and graphs — no custom Python, no per-integration MKP. It's all one Setup rule.

Targets Checkmk 2.4+ (any edition).

Start here

• Installation — get the .mkp onto your site
• Configuration — the rule, endpoints and fields explained
• JSON paths — the dotted path syntax, arrays and wildcards
• Examples / Cookbook — copy-paste recipes for common APIs
• Explorer — build your rule from a sample response, in the browser
• Troubleshooting — service is UNKNOWN? path not found? start here
• Security notes — SSRF, redirects, TLS and secret handling

In one minute

1. Install the MKP (Installation).
2. Setup → Agents → Other integrations → Generic JSON API → create a rule.
3. Add an endpoint (the URL to fetch) and one or more fields to monitor (a JSON path → a service).
4. Save, activate changes, run service discovery on the host — your JSON … services appear.

This wiki is the task-oriented "how do I…" guide. The README is the canonical reference; where they disagree, the README wins.