Sign in

v4

latestOpenAPI 3.1.02026-07-31155218294.8 KB
Agents

List Instances

get/v1/agents

Query parameters

state'active' | 'inactive' | 'all'

Which instances to return: active, inactive, or all (both)

Which instances to return: active, inactive, or all (both)

Headers

xi-api-keystring nullable
x-api-keystring nullable

Response

Successful Response

idstring required
namestring required
state'creating' | 'starting' | 'running' | 'stopping' | 'stopped' | 'failed' | 'deleted' required
start_tsinteger required
state_tsinteger required
stop_tsinteger nullable required
price_per_hournumber required
regionstring required
last_backup_tsinteger nullable required
ssh_portinteger required
fail_reasonstring nullable required
public_ipstring nullable required
versionstring nullable required
agent_typestring required
ssh_userstring required

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

plan_idstring required