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.
/api/v1/servers/{id}/factstse_sessionAPI key · cookierequiredidstringrequiredOK
archstringcomponentsServerComponentResponse[]requiredShow propertiesHide properties
ServerComponentResponsenamestringrequiredThe name of the component, for example etcd or node_exporter
versionstringrequiredmesh_pathstringThe path of the mesh from the console to the server
directrelayedos_idstringos_versionstringpack_releasestringThe newest release of the server packages that the server installed packages from
patroniServerPatroniResponseShow propertiesHide properties
lag_secondsnumber<double>The replication lag of a replica, in seconds
rolestringleaderstandby_leadersync_standbyreplicastatestringrunningstreamingnot_streamingstoppedtimelineinteger<int64>timeline_matches_leaderbooleanA replica only: true when the replica is on the timeline of its leader
postgresql_versionstringThe PostgreSQL version of the server, for example 18.1
reboot_requiredbooleanThe 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_pendingbooleanA deploy left a PostgreSQL restart to do on the server
serviceServerFactsServiceResponseShow propertiesHide properties
idstringrequiredlicense_capsstringapplied: 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
appliednot_neededwait_for_restartlicense_guardstringThe license guard of the service: loaded or not loaded. Not set when licensing does not apply or the guard was not checked
loadednot_loadednamestringrequiredversions_differstring[]requiredThe versions of this server that are not the versions of most PostgreSQL servers of the service
timescaledb_versionstringThe newest TimescaleDB library on the server
uptime_secondsnumber<double>Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message