v4

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-0124040.9 KB
Scoped API - Hosts

List hosts with IP, groups, and optional stats

Retrieve a list of all hosts with their IP addresses and associated host groups. Use include=stats to add package update counts (updates_count, security_updates_count, total_packages) to each host. Requires Basic Auth with scoped credentials (host:get permission).

get/api/hosts

Query parameters

hostgroupstring

Filter by host group name(s) or UUID(s). Comma-separated.

includestring

Comma-separated. Supported: stats (adds updates_count, security_updates_count, total_packages, needs_reboot, os_type, os_version, last_update, status, reporting_state, update_state). reporting_state is one of 'reporting' | 'overdue' | 'stale'. update_state is one of 'up_to_date' | 'updates_pending' | 'security_required'.

Response

OK

object required
All 24 operations