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

Get Patroni health

Patroni health for a database service.

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

OK

console_mesh_downboolean

The console reaches no enrolled server over the mesh, so the members were not checked.

errorstring
statusstringrequired
Allowed:healthyunhealthyerror
topologyClusterStatus
Show properties
membersMember[]required
Show properties
Array of Member
api_urlstring
hoststringrequired
laginteger<int64>
namestringrequired
pending_restartboolean
portinteger<int64>
rolestringrequired
server_idstring
statestringrequired
timelineinteger<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/database-services/string/health/patroni' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "console_mesh_down": true,
  "error": "string",
  "status": "healthy",
  "topology": {
    "members": [
      {
        "api_url": "string",
        "host": "string",
        "lag": 0,
        "name": "string",
        "pending_restart": true,
        "port": 0,
        "role": "string",
        "server_id": "string",
        "state": "string",
        "timeline": 0
      }
    ]
  }
}