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 Not yet released	Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)
2.4.0p1 Not yet released	Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)
2.3.0p32 Not yet released	Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)

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