Skip to content
SupaCloud Docs
Select themeSelect language

`PUT /api/runners/license-pools/{name}` — declare or re-declare a pool.

PUT
/api/runners/license-pools/{name}
curl --request PUT \
  --url https://example.com/api/runners/license-pools/example \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "seats": 1 }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
string

Pool name (normalised to lower case)

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

The declaration body for PUT /api/runners/license-pools/{name}.

object
description
string | null
seats
required

Concurrent seats the operator holds. Must be at least 1 — to retire a pool, DELETE it rather than setting it to zero (a zero-seat pool would wedge every task naming it, forever, with no signal).

integer format: int32
Examplegenerated
{
  "description": "example",
  "seats": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

The declared pool

Media typeapplication/json

A runner_license_pools row: how many CONCURRENT seats of one desktop tool the operator actually holds. Instance-wide by design (a tool licence is a fact about the operator’s machines, not a tenant preference — see migration 360).

Occupancy is deliberately NOT a column. It is derived at claim time from the open runner_work_assignments whose stored payload names this pool, so every release path — terminal report, runner crash + lease expiry, pickup timeout, cancel — frees the seat with no ledger to reconcile.

object
created_at
required
string format: date-time
created_by
string | null format: uuid
description
string | null
id
required
string format: uuid
name
required

The name a task references as config.runner.license_pool.

string
seats
required

Concurrent seats. Always > 0 (a zero-seat pool would wedge its tasks forever, so the DB CHECK refuses it — that is a deletion, not a setting).

integer format: int32
updated_at
required
string format: date-time
Examplegenerated
{
  "created_at": "2026-04-15T12:00:00Z",
  "created_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "description": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "seats": 1,
  "updated_at": "2026-04-15T12:00:00Z"
}

400

Section titled “400”

Blank name or non-positive seat count

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}