Werk #16364: tag_group: change the identification field from 'ident' to 'id'

Component REST API
Title tag_group: change the identification field from 'ident' to 'id'
Date Jan 29, 2024
Level Trivial Change
Class Bug Fix
Compatibility Incompatible - Manual interaction might be required
Checkmk versions & editions
2.4.0b1 Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)
2.3.0b1 Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)
2.2.0p22 Checkmk Raw (CRE), Checkmk Enterprise (CEE), Checkmk Cloud (CCE), Checkmk MSP (CME)

Before this Werk, when creating a tag group, the ident field was used to provide its identification as well as that of the tags associated to the group, however the information was returned in the id field. This Werk unifies the names and now the ident fields are renamed to id. Users should adapt their scripts accordingly.

For comptatibility reasons CheckMK 2.2.0 and 2.3.0 will support both id and ident, but ident will be removed on the next version.

The following example shows the changes that need to be applied to the payload to use this endpoint:

Original payload:

{
    "ident": "test_group",
    "title": "Test group",
    "help_text": "My test groupd",
    "tags": [
        {"ident": "test", "title": "Test Tag"}
    ]
}

Updated payload:

{
    "id": "test_group",
    "title": "Test group",
    "help_text": "My test groupd",
    "tags": [
        {"id": "test", "title": "Test Tag"}
    ]
}

To the list of all Werks