Skip to navigation

Rename an instruction or change its rebuild setting

View as MarkdownOpen in Claude

Changes the name of an instruction, its run_again_on_rebuild setting, or both. The commands, files or hostname in data cannot change; to run something different, delete the instruction and create a new one.

Use run_again_on_rebuild to choose whether the instruction runs again each time its node boots from its image instead of from a checkpoint, for example after a rebuild from first boot.

Requires: the simulation ACTIVE or INACTIVE, and the instruction not IN_PROGRESS; otherwise 400. Instructions that Air created (created_by_client is false) can be changed only by an Air admin or SRE.

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.

Path parameters

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

Request

This endpoint expects an object.
namestringOptional<=256 characters
The name of the instruction.
run_again_on_rebuildbooleanOptional
If the instruction should be run again if the simulation is rebuilt.

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
404
Not Found Error
500
Internal Server Error