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 build version

Returns the build version of the console, and the result of the update check when the check is on.

GET/api/v1/version
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

branchstring
buildTimestringrequired
commitstringrequired
tagstring
updateUpdateStatus

The result of the update check. Absent when the check is off (Check for new releases on the About page) or the console is not a release build

Show properties
lateststring

The newer release tag. Set only when status is available

statusstringrequired

unchecked: no answer yet. current: no newer release. available: latest is newer. failed: the check could not read latest.json (only from check-for-update)

Allowed:uncheckedcurrentavailablefailed
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/version' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "branch": "string",
  "buildTime": "string",
  "commit": "string",
  "tag": "string",
  "update": {
    "latest": "string",
    "status": "unchecked"
  }
}