Xeonr Developer Docs
API SpecificationWarm Pools

Configure Pool

POST
/containers.api.v1.PoolService/ConfigurePool

Creates or replaces the warm pool for lane, warming pods from environment_id, which must be in namespace. min_idle must not exceed max when max is set. Returns Unimplemented when warm pools are disabled (no Redis configured).

Access: operator or admin role in the namespace (via Xeonr team role or a namespace API key), or a platform admin.

Authorization

BearerAuth
AuthorizationBearer <token>

A namespace-scoped API key (cpk_…) for machines, or a Xeonr Auth OIDC token for humans. The key's namespace and role are pinned server-side.

In: header

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

lane?string
Length1 <= length <= 255
namespace?string
Length1 <= length <= 64
environmentId?string
Length1 <= length <= 64
minIdle?integer

validate:skip no bound beyond min_idle <= max (when max is set), which is cross-field and checked by the handler

max?integer

validate:skip 0 means uncapped; the server applies no ceiling

resources?
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.PoolService/ConfigurePool" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "pool": {
    "lane": "string",
    "namespace": "string",
    "environmentId": "string",
    "minIdle": 0,
    "max": 0,
    "resources": {
      "cpuMillis": 0,
      "memoryMb": 0,
      "ephemeralMb": 0,
      "pids": 0
    }
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Warm Pools

Warm pools — pre-warmed, identity-free, single-shot pods claimed per lane.

Delete Pool POST

Deletes a lane's pool configuration and drains its warm pods. Returns Unimplemented when warm pools are disabled (no Redis configured). **Access:** operator or admin role in the pool's namespace, or a platform admin.