Skip to main content
Local admin access only

This REST API is for local control by a client with direct access to the Kerrigan admin interface. Normal cloud controllers cannot access it; use the cloud-control interfaces instead.

Read local maintenance intent and device state

GET 
/v1/maintenance/:scope/:scope_id

Read an appliance (global/all), local pool (pool/{pool_id}), or device (device/{target_id}) scope. Pool IDs are local to this Kerrigan instance. The response includes this scope's own enabled and reason, enabled parent scopes in inherited_scopes, and affected devices with effective maintenance state. Inspect each device's phase, blocked, and error: a scope with enabled: false can still inherit maintenance. Phases are entering, active, exiting, normal, and error. Wait for active before maintenance operations such as OTA updates, and normal with blocked: false before returning the device to ordinary work.

Request​

Responses​

Successful Response