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

Get console feature flags

Returns the feature flags of the console, the metrics engine state, the build commit and the console ID.

GET/api/v1/info
Responses
200

OK

commitstringrequired

Git commit of the running console build

consoleIdstring

The console id: the SHA-256 of the mesh CA certificate. Absent before the mesh CA exists

degradedDegradedInfo

Set while the console database cannot be opened; every other API call answers 503

Show properties
databasestring

Console database path and the error that keeps it from opening

startupstring

Set after the database opened while the console still starts its services

demoEnablebooleanrequired

The console can start demo servers (TSE_DEMO_URL)

metricsEnginestringrequired

Metrics engine health: up or down

Allowed:updown
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/info' \
  -H 'Accept: application/json'
Response
{
  "commit": "string",
  "consoleId": "string",
  "degraded": {
    "database": "string",
    "startup": "string"
  },
  "demoEnable": true,
  "metricsEngine": "up"
}