Skip to main content
GET
Get Instance

Authorizations

Authorization
string
header
required

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

Headers

xi-api-key
string | null
x-api-key
string | null

Path Parameters

instance_id
string
required

Response

Successful Response

id
string
required
name
string
required
state
enum<string>
required
Available options:
creating,
starting,
running,
stopping,
stopped,
failed,
deleted
start_ts
integer
required
state_ts
integer
required
stop_ts
integer | null
required
price_per_hour
number
required
region
string
required
last_backup_ts
integer | null
required
ssh_port
integer
required
fail_reason
string | null
required
public_ip
string | null
required
version
string | null
required
agent_type
string
required
ssh_user
string
required

POSIX user the agent runs as inside the VM; also the SSH login user.

plan_id
string
required