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

Get server software and state

Returns the software of a server (OS, versions, components) and its state (uptime, reboot, restart, Patroni member, mesh path, license). A value that the console does not know is not in the response. It runs no command on the server.

GET/api/v1/servers/{id}/facts
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Responses
200

OK

archstring
componentsServerComponentResponse[]required
Show properties
Array of ServerComponentResponse
namestringrequired

The name of the component, for example etcd or node_exporter

versionstringrequired
mesh_pathstring

The path of the mesh from the console to the server

Allowed:directrelayed
os_idstring
os_versionstring
pack_releasestring

The newest release of the server packages that the server installed packages from

patroniServerPatroniResponse
Show properties
lag_secondsnumber<double>

The replication lag of a replica, in seconds

rolestring
Allowed:leaderstandby_leadersync_standbyreplica
statestring
Allowed:runningstreamingnot_streamingstopped
timelineinteger<int64>
timeline_matches_leaderboolean

A replica only: true when the replica is on the timeline of its leader

postgresql_versionstring

The PostgreSQL version of the server, for example 18.1

reboot_requiredboolean

The OS of the server asks for a reboot. Not set for a demo server, or when the last read is old

reboot_required_sincestring<date-time>
restart_pendingboolean

A deploy left a PostgreSQL restart to do on the server

serviceServerFactsServiceResponse
Show properties
idstringrequired
license_capsstring

applied: the license caps limit PostgreSQL on this server. not_needed: the server fits the license size. wait_for_restart: the caps of the license are not the limits of PostgreSQL yet; they apply at the next restart

Allowed:appliednot_neededwait_for_restart
license_guardstring

The license guard of the service: loaded or not loaded. Not set when licensing does not apply or the guard was not checked

Allowed:loadednot_loaded
namestringrequired
versions_differstring[]required

The versions of this server that are not the versions of most PostgreSQL servers of the service

timescaledb_versionstring

The newest TimescaleDB library on the server

uptime_secondsnumber<double>
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/string/facts' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "arch": "string",
  "components": [
    {
      "name": "string",
      "version": "string"
    }
  ],
  "mesh_path": "direct",
  "os_id": "string",
  "os_version": "string",
  "pack_release": "string",
  "patroni": {
    "lag_seconds": 0.1,
    "role": "leader",
    "state": "running",
    "timeline": 0,
    "timeline_matches_leader": true
  },
  "postgresql_version": "string",
  "reboot_required": true,
  "reboot_required_since": "2019-08-24T14:15:22Z",
  "restart_pending": true,
  "service": {
    "id": "string",
    "license_caps": "applied",
    "license_guard": "loaded",
    "name": "string",
    "versions_differ": [
      "postgresql"
    ]
  },
  "timescaledb_version": "string",
  "uptime_seconds": 0.1
}