Skip to main content
GET
Get Pool

Authorizations

Authorization
string
header
required

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

Path Parameters

pool_id
string<uuid>
required

Query Parameters

include_machines
boolean
default:false

[Deprecated] Use include=machines instead. Include full machine details

include
string | null

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

Response

Successful Response

Pool response with optional included related resources.

id
string<uuid>
required
organization_id
string
required
name
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
pool_parameters
Pool Parameters · object | null
pool_sensitive_parameters
Pool Sensitive Parameters · object | null
machine_count
integer | null
default:0

Number of machines in this pool

machines
MachineResponse · object[] | null

[Deprecated] Machines in this pool. Use included array instead.

included
IncludedResource · object[] | null

Related resources requested via the include query parameter