Skip to main content
GET
Get Machine

Authorizations

Authorization
string
header
required

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

Path Parameters

machine_id
string<uuid>
required

Query Parameters

include
string | null

Comma-separated list of related resources to include. Allowed values: pools. Example: include=pools

Response

Successful Response

Machine response with optional included related resources.

id
string<uuid>
required
unkey_key_id
string
required
status
enum<string>
required
Available options:
connected,
disconnected,
error
is_available
boolean
required
alerts_enabled
boolean
required
created_at
string<date-time>
required
last_seen
string<date-time>
required
user_id
string<uuid> | null
organization_id
string | null
name
string | null
version
string | null
hostname
string | null
os_info
string | null
machine_parameters
Machine Parameters · object | null
machine_sensitive_parameters
Machine Sensitive Parameters · object | null
reserved_session_id
string<uuid> | null
linked_keepalive_machine_id
string<uuid> | null
physical_server_id
string | null
pools
PoolResponse · object[] | null
included
IncludedResource · object[] | null

Related resources requested via the include query parameter