Explore the latest product updates and best practices at our hybrid Checkmk Conference #12 from June 16-18, 2026 – Register here

Werk #17952: REST-API: Improve documentation for rule endpoints

Component REST API
Title REST-API: Improve documentation for rule endpoints
Date May 7, 2025
Level Trivial Change
Class Bug Fix
Compatibility Compatible - no manual interaction needed
Checkmk versions & editions
2.5.0b1 Checkmk Community, Checkmk Pro, Checkmk Ultimate, Checkmk Ultimate MT
2.4.0p1 Checkmk Community, Checkmk Pro, Checkmk Ultimate, Checkmk Ultimate MT
2.3.0p33 Checkmk Community, Checkmk Pro, Checkmk Ultimate, Checkmk Ultimate MT

This Werk improves the REST API documentation to better reflect the actual request and response schemas.

Specifically, this means:

  • marking host_labels and service_labels as deprecated in the create and update endpoints
  • removing them entirely in the response schemas for all rule endpoints

This does not change the behaviour of these endpoints, as the shift to host_label_groups and service_label_groups already happened in Werk #16045.

It is recommended to migrate to label groups, as the old way of configuring labels will be removed in a future version of Checkmk.

To the list of all Werks