Skip to main content
POST
/
v1
/
pools
/
{pool_id}
/
machines
Add Machines To Pool
curl --request POST \
  --url https://api.cyberdesk.io/v1/pools/{pool_id}/machines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "machine_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}'
{
  "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>",
      "machine_parameters": {},
      "machine_sensitive_parameters": {},
      "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,
      "reserved_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "linked_keepalive_machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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

Body

application/json

Schema for assigning machines to pools

​
machine_ids
string<uuid>[]
required

List of machine IDs to assign to the pool

Minimum length: 1

Response

Successful Response

Pool response with machines included

​
name
string
required
Required string length: 1 - 255
​
id
string<uuid>
required
​
organization_id
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[]