pools

Get Pool

Get a specific pool by ID.

Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern.

Note: The include_machines parameter is deprecated. Use include=machines instead.

get/v1/pools/{pool_id}

Request

Base URL
https://api.cyberdesk.io
URL
https://api.cyberdesk.io/v1/pools/{pool_id}
Auth
HTTP bearer

Path parameters

pool_idstring uuid required

Query parameters

include_machinesboolean

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

includestring nullable

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

Response

Successful Response

idstring uuid required

organization_idstring required

namestring required

descriptionstring nullable

pool_parametersobject nullable

pool_sensitive_parametersobject nullable

created_atstring date-time required

updated_atstring date-time required

machine_countinteger nullable

Number of machines in this pool

Changes

No recorded changes to this operation across all 2 revisions of this API.