Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/runners/license-pools` — every declared pool with live occupancy.

GET
/api/runners/license-pools
curl --request GET \
  --url https://example.com/api/runners/license-pools

Responses

Section titled “Responses”

200

Section titled “200”

Declared licence pools with their occupied seats

Media typeapplication/json
Array

A pool as the operator surface shows it: the declaration plus how many seats are occupied right now.

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
occupied
required

Seats currently held by claimed/running work with a live lease. A SNAPSHOT — the gate does its own counting inside the claim transaction, and the two must never be conflated.

integer format: int64
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",
    "occupied": 1
  }
]

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"
}