Skip to navigation

Create an instruction on a device

View as MarkdownOpen in Claude

Create a new instruction for a device which boots an operating system of its own (e.g. a DPU), naming the device rather than the node it runs. This operation is only permitted when the simulation is in the ACTIVE or INACTIVE state.

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

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
DeviceInitInstructionCreateSchemaRequestobjectRequired

Schema for the init executor on the device route.

OR
DeviceFileInstructionCreateSchemaRequestobjectRequired

Schema for the file executor on the device route.

OR
DeviceShellInstructionCreateSchemaRequestobjectRequired

Schema for the shell executor on the device route.

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

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error