Skip to main content
PUT
/
api
/
v0
/
instances
/
{id}
manage instance
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"
}
'
{
  "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

Operation completed successfully

​
success
boolean
Example:

true