Werk #22452: REST API: New endpoints for host and service availability
| Component | REST API | ||
| Title | REST API: New endpoints for host and service availability | ||
| Date | Oct 7, 2026 | ||
| Level | Prominent Change | ||
| Class | New Feature | ||
| Compatibility | Compatible - no manual interaction needed | ||
| Checkmk versions & editions |
|
You can now query the availability data of hosts and services via the REST API.
The endpoints return the same figures as the availability view in the GUI and
are available in the unstable API version.
Host availability
GET /domain-types/host_availability/collections/all: list the availability of all hosts, optionally restricted to one site viasite_id.GET /objects/host_availability/{host_name}: show the availability of a single host.site_idis optional, but required if the same host name exists on more than one site.
Service availability
GET /domain-types/service_availability/collections/all: list the availability of all services on one host (site_idandhost_nameare required).GET /objects/host/{host_name}/service_availability/{service_name}: show the availability of a single service.site_idis optional, but required if the same host name exists on more than one site.
All endpoints take the time range as time_range_from and time_range_until
(ISO 8601 datetimes with a timezone).
Each result reports the seconds spent in each of these states: up, down, unreachable (hosts) or ok, warn, crit, unknown (services), plus in downtime, flapping, host down (services), outside the notification or service period, and unmonitored. It also contains the total and the considered duration, and the full state timeline. You need the permission See the availability to use them.