Skip to navigation

List device instructions

View as MarkdownOpen in Claude

Lists the instructions on devices that boot an operating system of their own, such as DPUs, in every simulation you can read. Each one names its device rather than the node the device runs. Pass device to narrow the list to one device.

Required scope: Simulation Read (roles: Air Org Administrator, Air User)

Alternative: the Air Trainee role also grants access.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

created_by_clientbooleanOptional

Only instructions a client created (true) or Air created (false).

devicestringOptionalformat: "uuid"
Only this device's instructions.
executorenumOptional
  • init - Initialize the node’s hostname
  • file - Write files to the node’s file system
  • shell - Execute shell commands on the node
Allowed values:
limitintegerOptional
Number of results to return per page.
namestringOptional
Only instructions with exactly this name.
offsetintegerOptional
The initial index from which to return the results.
orderingenumOptional

Order the results by this field. Prefix with - for descending order. Default: created.

run_again_on_rebuildbooleanOptional

Only instructions that do (true) or do not (false) run again when their node is rebuilt.

searchstringOptional

Search by name.

simulationstringOptionalformat: "uuid"
Only instructions on this simulation's nodes.
stateenumOptional

The current lifecycle state of this instruction. Defaults to NOT_READY; transitions to READY once the target VM is running.

  • NOT_READY - The instruction exists but is not yet ready for worker pickup.
  • READY - The instruction is ready to be picked up and executed.
  • IN_PROGRESS - The instruction has been picked up by the worker.
  • COMPLETE - The instruction was successfully executed.
  • FAILED - The instruction failed to finish execution.
  • CANCELLED - The instruction was cancelled before execution.

Response

countinteger
resultslist of objects
nextstring or nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error