Skip to content
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Get demo server capacity

The memory of Docker on the demo host, the demo servers that exist, and how many more fit. The demo sidecar refuses a new demo server when none fits.

GET/api/v1/servers/demo-capacity
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

demo_memory_mbinteger<int64>required

The memory of PostgreSQL on each demo server, in MB

freeinteger<int64>required

The number of demo servers that Docker has memory for in addition

memory_bytesinteger<int64>required

The memory of Docker on the demo host, in bytes

serversinteger<int64>required

The demo servers that exist, also stopped ones

default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/servers/demo-capacity' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "demo_memory_mb": 0,
  "free": 0,
  "memory_bytes": 0,
  "servers": 0
}