Learn more about the latest product updates at the Checkmk Conference #12 – live from June 16-17! Watch here
back to website

Werk #19984: Manage master control settings via the REST API

Component REST API
Title Manage master control settings via the REST API
Date Jun 11, 2026
Level Trivial Change
Class New Feature
Compatibility Compatible - no manual interaction needed
Checkmk versions & editions
3.0.0b1
Not yet released 		Checkmk Community, Checkmk Pro, Checkmk Ultimate, Checkmk Cloud, Checkmk Ultimate MT

You can now switch a site's master control settings on and off through the REST API. These are the same monitoring switches you find in the Master control snap-in of the sidebar.

A new endpoint family is available:

  • GET /domain-types/master_control/collections/all lists the settings of all sites you can access.
  • GET /objects/master_control/{site_id} shows the settings of a single site.
  • PATCH /objects/master_control/{site_id} changes them.

The following settings can be toggled: notifications, service checks, host checks, flap detection, event handlers (named "alert handlers" in editions other than Checkmk Community) and performance data (named "Metrics" in the user interface).

The PATCH request accepts partial updates: only the settings you include in the request body are changed, the others are left untouched. It returns no content. Accessing these endpoints requires the same permission as the Master control snap-in.

Good to know

Changes are sent to the monitoring core as Livestatus commands. The endpoint does not wait for the core to apply them, so a change may take a moment to take effect. Read the settings again with a GET request if you need to confirm the new state.

To the list of all Werks