v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB

pools

Update Pool

Update a pool's details.

patch/v1/pools/{pool_id}

Path parameters

pool_idstring uuid required

Headers

Idempotency-Keystring

Example:550e8400-e29b-41d4-a716-446655440000

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.

Request body

namestring nullable

descriptionstring nullable

pool_parametersobject nullable

Pool-level input values. Provide empty dict {} to clear all.

pool_sensitive_parametersobject nullable

Pool-level sensitive input values (will be stored in Basis Theory). Provide empty dict {} to clear all.

Response

Successful Response

namestring required

descriptionstring nullable

pool_parametersobject nullable

Pool-level input values that auto-populate runs selecting this pool

pool_sensitive_parametersobject nullable

Pool-level sensitive input aliases (stored in Basis Theory)

idstring uuid required

organization_idstring required

created_atstring date-time required

updated_atstring date-time required

machine_countinteger nullable

Number of machines in this pool