Skip to main content
GET
/
v1
/
pools
/
{pool_id}
Get Pool
curl --request GET \
  --url https://api.cyberdesk.io/v1/pools/{pool_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "machine_count": 0,
  "machines": [
    {
      "fingerprint": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unkey_key_id": "<string>",
      "status": "connected",
      "is_available": true,
      "created_at": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "version": "<string>",
      "hostname": "<string>",
      "os_info": "<string>",
      "machine_parameters": {},
      "machine_sensitive_parameters": {},
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "<string>",
      "reserved_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "linked_keepalive_machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "physical_server_id": "<string>",
      "pools": [
        {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "organization_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "machine_count": 0
        }
      ]
    }
  ],
  "included": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

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
​
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