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

Get etcd health

etcd health for a database service.

GET/api/v1/database-services/{id}/health/etcd
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
membersEtcdMemberHealth[]
Show properties
Array of EtcdMemberHealth
causestring

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

Allowed:downunverifiedunhealthy
errorstring
healthybooleanrequired
hoststringrequired
overlay_ipstring
server_idstringrequired
statusstringrequired
Allowed:healthyunhealthyerror
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/etcd' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "console_mesh_down": true,
  "error": "string",
  "members": [
    {
      "cause": "down",
      "error": "string",
      "healthy": true,
      "host": "string",
      "overlay_ip": "string",
      "server_id": "string"
    }
  ],
  "status": "healthy"
}