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

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

Include full machine details

Response

200
application/json

Successful Response

Pool response with machines included