Skip to navigation

Get an instruction

View as MarkdownOpen in Claude

Returns one instruction: the node it targets, its data (the commands to run, the files to write or the hostname to set), and its state. Instructions that Air creates itself, such as the hostname setup of each node, are returned as well.

Use this operation to follow an instruction after you create it. The worker has run the instruction when state is COMPLETE or FAILED. CANCELLED means that the instruction was cancelled before it ran.

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.

Path parameters

idstringRequiredformat: "uuid"
A UUID string identifying this instruction.

Response

InitInstructionReadobject
Representation of a hostname assignment instruction.
OR
FileInstructionReadobject
Representation of an instruction that writes files to a node.
OR
ShellInstructionReadobject
Representation of an arbitrary shell execution instruction.

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error