Skip to main content
GET
Get a run with its steps

Updated 23 Oct 2026 15:20 · page 97a4fd3

Authorizations

Authorization
string
header
required

Mint a token from the portal at Settings → API tokens. Send it as Authorization: Bearer avb_... on every request. Query-string tokens are NOT accepted — the URL ends up in access logs.

Path Parameters

id
string<uuid>
required

Run id (UUID).

Response

The run and its steps.

id
string<uuid>
required
kind
enum<string>
required

power: the room switched off at night and back on. readiness: a test routine.

Available options:
power,
readiness
room_id
string<uuid>
required
room
string
required
building_id
string<uuid>
required
building
string
required
status
enum<string>
required
Available options:
pending,
in_progress,
succeeded,
failed,
skipped
phase
enum<string>
required

How far the run got. ready means the room passed.

Available options:
pending,
scheduled_off,
off,
scheduled_on,
waking,
warming,
testing,
ready,
failed
scheduled_at
string<date-time>
required
steps_total
integer
required

Steps recorded so far, including the scheduled power off and power on.

steps_passed
integer
required
steps_failed
integer
required
steps
object[]
required
routine_id
string<uuid> | null

The test routine the run used; null for a power-cycle-only run.

routine
string | null
started_at
string<date-time> | null

When the run began: the evening power-off, or the start of a run without a power cycle.

powered_on_at
string<date-time> | null

When the morning power-on began; null until then, and for runs without a power cycle.

completed_at
string<date-time> | null
duration_seconds
integer | null

How long the room took to be ready (or to fail) after power-on; for a run without a power cycle, from its start.

failure_reason
string | null