back to website

Werk #16726: rest_api: Improve downtime creation documentation

Component REST API
Title rest_api: Improve downtime creation documentation
Date Apr 2, 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.0b4 Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)
2.3.0p31 Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)

This Werk adds more information to the REST API documentation about the downtime_type field present in Create a host related scheduled downtime and Create a service related scheduled downtime. Valid options for these fields are

For host related downtimes:

  • host - Schedule downtimes for a host identified by its name or IP address
  • hostgroup - Schedule downtimes for all hosts belonging to the specified host group
  • host_by_query - Schedule downtimes for all hosts matching the query

For service related downtimes:

  • service - Schedule downtimes for services whose names appear in service_descriptions and belong to the host identified by its name or IP address in host_name
  • servicegroup - Schedule downtimes for all services in a specified service group
  • service_by_query - Schedule downtimes for services matching the query

To the list of all Werks