Description

A guided setup wizard for the Generic JSON API agent — build a monitoring rule from your API's real response, right inside Checkmk.

This is the optional companion to the Generic JSON API package. It adds an in-site wizard under Setup → Quick setup that walks you from a live API response to a finished rule — no rules.mk, no curl, no leaving Checkmk.

Requires

  • The Generic JSON API (json_api) package must be installed and enabled first — this Explorer only builds rules for that agent; it does not monitor anything on its own.
  • Checkmk 2.5 or newer, any edition. The wizard is built on Checkmk's native Quick-Setup UI, which does not exist on 2.4.

What it does

  • 🧭 Guided, step by step — choose the target folder and host, define one or more endpoints (URL, method, auth, headers, TLS/redirect options), then pick the fields to monitor.
  • 🔎 Fetches the real response — the wizard calls each endpoint from the site and shows you the actual JSON, so you click the fields that exist instead of guessing paths.
  • 🎯 Point-and-pick fields — select values by path, set WARN/CRIT thresholds, units, a numeric transform, element counting, or string matching — the same options the agent supports.
  • Live preview before you commit — the review step evaluates every chosen field against the fetched sample and shows the resulting service state, so you catch a wrong path or threshold before the rule exists.
  • 🔐 Secure by default — credentials are stored in the Checkmk password store and referenced, never written in clear text; TLS verification stays on.
  • 🚀 One click to create — the wizard writes the finished Generic JSON API rule for you.

In short

Install the Generic JSON API agent, then install this Explorer. Open Setup → Quick setup → Generic JSON API, point it at an endpoint, tick the fields you care about, and press create. The services appear on your host.

Details

  • Extra/companion package — install alongside, and after, the Generic JSON API agent.
  • Checkmk 2.5+, any edition.
  • Install via mkp add / mkp enable, or Setup → Extension packages.
  • GPL-2.0-only.
Version 0.8.0
Latest version

Uploaded on: 14 Jul 2026

Downloads: 0

Built on Checkmk version: checkmk-json-agent 0.8.0

Minimum Checkmk version required: 2.5.0

MKP MD5 hash: cea7ff59b57c3c53ba01018aab904372