Werk #22737: HTML Email: REST API reads and writes the SMTP password in the wrong format
| Component | Notifications | ||
| Title | HTML Email: REST API reads and writes the SMTP password in the wrong format | ||
| Date | Nov 19, 2026 | ||
| Level | Trivial Change | ||
| Class | Bug Fix | ||
| Compatibility | Incompatible - Manual interaction might be required | ||
| Checkmk versions & editions |
|
The REST API endpoints for notification rules handled the password of the option "Enable synchronous delivery via SMTP" of the HTML Email notification method as plain text, while the Setup and the notification script use the password format:
- Rules created or changed through the REST API could not send notifications, because the notification script failed to read the password.
- Reading a rule whose SMTP password was saved in the Setup returned the internal representation of the password instead of the password. Writing such a rule back stored that representation as the new password, so the SMTP login failed.
- A password from the password store, which can be configured in the Setup, could not be represented at all.
The REST API now stores the SMTP password in the same format as the Setup. Passwords written by the REST API work again without any changes. The same applies to personal notification rules that were saved before Checkmk 2.4: their SMTP password was stored as text, so they could not send notifications either.
This does not apply to rules that were read through the REST API and written back: their password was replaced with the internal representation, so their SMTP login still fails. Enter the SMTP password of these rules again.
This is an incompatible change for clients of the REST API endpoints for
notification rules (creating, updating and showing rules). In the plug-in
parameters of HTML Email, the field
enable_sync_smtp.value.auth.value.password is now an object instead of a
string, in requests and responses:
{"option": "explicit", "password": "<password>"}for a password entered explicitly{"option": "store", "store_id": "<password store ID>"}for a password from the password store, which must exist
For example, "password": "secret" becomes
"password": {"option": "explicit", "password": "secret"}.
The field is also required now when SMTP authentication is enabled. Before, it could be left out and defaulted to an empty password.