Skip to content
You're viewing documentation for v2026.11.13-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

List free servers

Lists the enrolled servers that no database service, DCS cluster, backup repository or LiveSync session uses, that wait for no cleanup, and that no action runs on. Such a server can fill an empty member slot.

GET/api/v1/servers/free
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

Array of FreeServerResponse
hoststringrequired
idstringrequired
memory_total_bytesinteger<int64>required
namestringrequired
reachableboolean

true when the fresh reachability note of the server says that the console reaches it, false when it says not. Absent when no fresh reading tells it, as for the reachable field of a server.

vcpusinteger<int64>required
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/free' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
[
  {
    "host": "string",
    "id": "string",
    "memory_total_bytes": 0,
    "name": "string",
    "reachable": true,
    "vcpus": 0
  }
]