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 server components

The files that the console gives to every server, from the components packs of the console release, with the version, the architectures and the sha256 of each one, and the lowest version that the console supports. installed has the version of each component that each server runs.

GET/api/v1/server-components
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

componentsServerComponent[]required
Show properties
Array of ServerComponent
archsServerComponentArch[]required
Show properties
Array of ServerComponentArch
archstringrequired

The server architecture

Allowed:amd64arm64
pathstringrequired

The file in the pack directory of the console

sha256stringrequired
min_reasonstring

Why the console needs at least min_version

min_versionstring

The lowest version of the component that this console supports on a server

namestringrequired
postgresql_majorstring

The PostgreSQL major of tsdbe

versionstringrequired

The version in the components pack of the console release

installedServerComponentInstall[]required

The version of each component that each server runs, as the console recorded it when it installed the component. A deploy installs these versions

Show properties
Array of ServerComponentInstall
componentstringrequired
recorded_atstring<date-time>required

When a play or the enroll script last installed the component

releasestringrequired

The release of the components pack that the version came from

serverstringrequired
server_idstringrequired
versionstringrequired
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/server-components' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "components": [
    {
      "archs": [
        {
          "arch": "amd64",
          "path": "string",
          "sha256": "string"
        }
      ],
      "min_reason": "string",
      "min_version": "string",
      "name": "string",
      "postgresql_major": "string",
      "version": "string"
    }
  ],
  "installed": [
    {
      "component": "string",
      "recorded_at": "2019-08-24T14:15:22Z",
      "release": "string",
      "server": "string",
      "server_id": "string",
      "version": "string"
    }
  ]
}