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 DCS cluster health

Live etcd member, quorum and dependent service health of a DCS cluster.

GET/api/v1/dcs-clusters/{id}/health
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
membersDcsMemberHealth[]required
Show properties
Array of DcsMemberHealth
causestring

Why the member is not healthy: down (no mesh path), unverified (the check failed), unhealthy (etcd says so), or empty (the slot has no server; server_id is empty). Empty when healthy.

Allowed:downunverifiedunhealthyempty
db_size_bytesinteger<int64>
errorstring
healthybooleanrequired
hoststringrequired
is_leaderbooleanrequired
member_namestringrequired
overlay_ipstring
previous_server_idstring
previous_server_namestring
raft_indexinteger<int64>
min 0
raft_terminteger<int64>
min 0
reachablebooleanrequired
rebuild_errorstringrequired
rebuild_pendingbooleanrequired
rebuild_statestringrequired

running, failed, or empty when no rebuild runs or failed

server_idstringrequired
server_namestringrequired
versionstring
quorumDcsQuorumrequired
Show properties
at_riskbooleanrequired
healthyinteger<int64>required
neededinteger<int64>required
sizeinteger<int64>required
servicesDcsDependentService[]required
Show properties
Array of DcsDependentService
idstringrequired
namestringrequired
statusstringrequired
statusstringrequired
Allowed:healthydegradedunhealthy
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/dcs-clusters/string/health' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "console_mesh_down": true,
  "error": "string",
  "members": [
    {
      "cause": "down",
      "db_size_bytes": 0,
      "error": "string",
      "healthy": true,
      "host": "string",
      "is_leader": true,
      "member_name": "string",
      "overlay_ip": "string",
      "previous_server_id": "string",
      "previous_server_name": "string",
      "raft_index": 0,
      "raft_term": 0,
      "reachable": true,
      "rebuild_error": "string",
      "rebuild_pending": true,
      "rebuild_state": "string",
      "server_id": "string",
      "server_name": "string",
      "version": "string"
    }
  ],
  "quorum": {
    "at_risk": true,
    "healthy": 0,
    "needed": 0,
    "size": 0
  },
  "services": [
    {
      "id": "string",
      "name": "string",
      "status": "string"
    }
  ],
  "status": "healthy"
}