The API is designed to distribute verifiable OS updates and hardware compatibility information to enrolled Ubuntu devices. This site is a design preview; the live control plane has not been deployed.
No production endpoint is available yet. Do not place access tokens or device data in this preview.
/v1/health/* and /v1/capabilities — service readiness and protocol support./v1/catalog/* — signed device profiles, driver bundles, ICU-AL, media pipelines, workloads, models, and network profiles./v1/devices/* — device enrollment, check-ins, minimized inventory, update checks, health, power-policy acknowledgements, and consented energy summaries./v1/uploads and /v1/releases — artifact upload sessions and signed release metadata./v1/rollouts — staged canary rings with pause/abort thresholds./v1/support/* — user-reviewed diagnostic cases and constrained read-only probes.Each update is tied to an OS, kernel, device profile, package/runtime, and ICU-AL compatibility tuple. The device verifies signature and digest locally, stages through its local update controller, performs a health check, and retains a rollback path. The server cannot run arbitrary commands, choose arbitrary packages, or change TPM, UEFI, Windows partitions, or firmware settings.
Devices use individually revocable mTLS credentials. Operators authenticate through the configured OIDC provider with MFA and narrowly scoped roles. Private keys remain on the device; optional telemetry is consent-based and minimized.
See API_V1_DESIGN.md in the ICU-OS source package for the complete endpoint catalogue, fields, scopes, and deployment phases.