Skip to main content
PATCH
/
v1
/
pools
/
{pool_id}
Update Pool
curl --request PATCH \
  --url https://api.cyberdesk.io/v1/pools/{pool_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "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
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

​
pool_id
string<uuid>
required

Body

application/json

Schema for updating a pool

​
name
string | null
Required string length: 1 - 255
​
description
string | null

Response

Successful Response

Pool response schema

​
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