Skip to content

Installation

Benjamin Knapp edited this page Jul 8, 2026 · 1 revision

Installation

Requirements

  • Checkmk 2.4.0 or newer, any edition (Raw, Enterprise, Cloud, MSP).
  • The Checkmk server must be able to reach the URLs you want to monitor — the agent runs from the site, not from the monitored host.

Install the MKP

Download the latest json_api-<version>.mkp from the Releases page.

Via the command line (as the site user)

mkp add json_api-0.6.0.mkp
mkp enable json_api 0.6.0

Via the GUI

Setup → Extension packages → Upload package, pick the .mkp, then enable it.

Either way, the new ruleset Generic JSON API appears under Setup → Agents → Other integrations.

Upgrading

Add and enable the newer version the same way — mkp add the new file, then mkp enable json_api <new-version>. Your rules are stored separately from the package, so they survive the upgrade. Check the CHANGELOG for anything version-specific.

Removing

mkp disable json_api
mkp remove json_api <version>

Disabling leaves your rules in place (they simply stop producing services); removing deletes the package files.

Building from source (optional)

You don't need a Checkmk install to build the package — the builder is stdlib-only:

make mkp        # -> json_api-<version>.mkp

See the README build section for details.


Next: Configuration.

Clone this wiki locally