Werk #19814: REST API: manage customers (Ultimate with multi-tenancy)
| Component | REST API | ||
| Title | REST API: manage customers (Ultimate with multi-tenancy) | ||
| Date | Apr 22, 2026 | ||
| Level | Trivial Change | ||
| Class | New Feature | ||
| Compatibility | Compatible - no manual interaction needed | ||
| Checkmk versions & editions |
|
You can now manage customer objects in Checkmk Ultimate with multi-tenancy via the REST API. This includes listing, creating, updating and deleting customers under the new Customers endpoint family. Until now, customer management was only possible through the Setup → Customer management UI, which made it impossible for managed service providers to onboard new customers as part of an automated script.
The managed attributes mirror the Customer properties form: the customer
id, a human-readable name, the list of CUSTOMER_* macros, and the
preferred customer_report_layout. The full request and response schemas
are available in the embedded API documentation at Help → REST API
→ Documentation.
Access and permissions
The endpoints are only available in Checkmk Ultimate with multi-tenancy and
require the existing Manage customers permission (wato.customer_management).
Write operations additionally check Make changes, perform actions
(wato.edit) like every other Setup endpoint.
Safety checks on delete
Deleting a customer is rejected with 400 Bad Request if you try to remove
the built-in provider customer, and rejected with 409 Conflict whenever
any site is still assigned to the customer. Both checks match the behavior
of the existing Customer management UI.
Not exposed via the API
Per-customer global setting overrides (the globals attribute) are preserved
when you update a customer, but they are not exposed through these endpoints -
mirroring the UI split between Customer management and
Customer-specific global settings.