manage instance

Manage instance state and labels. The operation is determined by the request body parameters.

CLI Usage:

• To stop: vastai stop instance <id>
• To start: vastai start instance <id>
• To label: vastai label instance <id> <label>

PUT /api/v0/instances/{id}

manage instance

cURL

curl --request PUT \
  --url https://console.vast.ai/api/v0/instances/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "stopped",
  "label": "My ML Training Job"
}
'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

id · integer · required

ID of the instance to modify

Body

application/json

At least one of these parameters should be provided

state · enum<string>

Change instance state (optional)

Available options: stopped, running

Example:

"stopped"

label · string

Text label to assign to the instance (optional)

Maximum string length: 1024

Example:

"My ML Training Job"

Response

200

application/json

Operation completed successfully

success · boolean

Example:

true