I would like to fully configure my Checkmk Server (2.0.0p4) over the REST-API and would like to know the current limitations i.e. what can and what cannot be configured.
Here’s a list of the areas I need to configure:
Server setup (SNMP port etc.)
Host and groups
Process monitoring (custom process rules)
Network topology (parent/child relationships)
Event console rules (parse complex SNMP traps)
Aggregation (Business Intelligence)
Hi @Asallante,
Checkmk provides you with an REST API documentation plus an REST API interactive GUI.
Just open up your Checkmk and at the Sidebar you’ll find the Help button. There you can find the REST API documentation.
Keep in mind that the API is still WIP and is subject to change.
For more information on the API you can read this Checkmk article → Configuration via the Checkmk REST-API
I’ve been through the docs and played with the interactive client. There are some conflicting statements around the API though…
" When a Checkmk-System has been installed, it can be 100% configured and operated using the web interface."
“The complete Setup menu functionality is in fact not available via API, but the most important things, such as the managing of hosts, folders, instances, users, groups and more is already possible.”
" As of Version 2.0.0, there is a new application programming interface in Checkmk: the Checkmk REST-API… the REST-API is intended to cover the complete functionality that Checkmk up until now has provided via the GUI and via the command interface, thus completely replacing the Web-API."
Keep in mind that the API is still WIP and is subject to change.
I guess this is the key point. WIP is understandable, however, is there a clear roadmap to deliver the remaining functionality around configuration?
the Checkmk team is currently working on the REST API Improvements. As you can see here → The Checkmk Roadmap
With the introduction of the REST-API in Checkmk 2.0 we extended the coverage even beyond the scope of the existing APIs. Our goal is however completeness of the new REST-API: Everything can be done via an API.
I can understand the frustration but Checkmk 2.0 made a huge development step forward. The REST API is just not fully finished yet. Maybe the old Web-API can help you in your use case →
This topic was automatically closed 365 days after the last reply. New replies are no longer allowed. Contact an admin if you think this should be re-opened.