Skip to main content
PUT
Update Instance

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Path Parameters

id
integer
required

The ID of the instance to start.

Body

application/json
label
string

Text label to assign to the instance

Example:

"My ML Training Job"

state
enum<string>

The desired state of the instance.

Available options:
running

Response

Returns {success: true} on update, or {success: false, error: "resources_unavailable", msg: "Required resources are currently unavailable, state change queued."} when the machine cannot start.

success
boolean

True when update was applied

error
string

Error code if success is false

msg
string

Human-readable message