Free on-demand webinars: Learn how to set up, configure, and get more out of Checkmk – Pick your webinar

Werk #22669: REST API: Fix crashes on incomplete notification method parameters

Component REST API
Title REST API: Fix crashes on incomplete notification method parameters
Date Nov 12, 2026
Level Trivial Change
Class Bug Fix
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
2.5.0p22
Not yet released
Checkmk Community, Checkmk Pro, Checkmk Ultimate, Checkmk Cloud, Checkmk Ultimate MT

Creating or editing a notification rule through the REST API failed with an internal server error (KeyError) in the following cases:

  • state_acknowledgement or state_recovery of the ServiceNow notification method had a value without start_predefined or start_integer.
  • state_downtime of the ServiceNow notification method had an empty value or a value with only end_predefined or end_integer.
  • management_type of the ServiceNow notification method was sent without params.
  • enable_sync_smtp of the HTML email notification method had a value without port or auth.
  • webhook_url of the Cisco Webex Teams notification method or jira_url of the Jira notification method was missing.

In the two state_downtime cases the rule was saved nevertheless. Reading notification rules through the REST API then failed in the same way. This also happened for rules saved in the Setup with a ServiceNow state that has no start state.

The REST API now behaves as follows:

  • A state_acknowledgement or state_recovery without a start state, a state_downtime with an empty value and a missing webhook_url or jira_url are rejected with status code 400.
  • A state_downtime with only an end state is accepted.
  • If params is missing, all its fields get their default values. A missing port defaults to 25 and a missing auth to disabled.
  • Rules with a ServiceNow state that has no start state can be read. A state that is stored without any value is returned as disabled.

To the list of all Werks