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

Get PostgreSQL info

PostgreSQL info for a database service.

GET/api/v1/database-services/{id}/info/postgresql
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Responses
200

OK

connectionsConnectionsInfo
Show properties
activeinteger<int64>required
idleinteger<int64>required
maxinteger<int64>required
totalinteger<int64>required
databasesDatabaseInfo[]
Show properties
Array of DatabaseInfo
namestringrequired
size_bytesinteger<int64>required
errorstring
membersPostgresqlMemberInfo[]required
Show properties
Array of PostgresqlMemberInfo
errorstring
namestringrequired
patroni_versionstring
postmaster_start_timestring
rolestringrequired
server_idstring
server_versioninteger<int64>
statestringrequired
stats_errorstring
total_size_bytesinteger<int64>
uptime_secondsinteger<int64>
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/database-services/string/info/postgresql' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "connections": {
    "active": 0,
    "idle": 0,
    "max": 0,
    "total": 0
  },
  "databases": [
    {
      "name": "string",
      "size_bytes": 0
    }
  ],
  "error": "string",
  "members": [
    {
      "error": "string",
      "name": "string",
      "patroni_version": "string",
      "postmaster_start_time": "string",
      "role": "string",
      "server_id": "string",
      "server_version": 0,
      "state": "string"
    }
  ],
  "stats_error": "string",
  "total_size_bytes": 0,
  "uptime_seconds": 0
}