close
Skip to content
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview
On this page

TimescaleDB Enterprise API

Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database services onto them via Ansible, and manages backups, restores, and health monitoring.

Authentication

All endpoints except login, logout, /auth/methods, /info, OIDC, and the enrollment script require a session cookie (tse_session). Obtain one with POST /api/v1/login using the console auth token (TSE_AUTH_TOKEN), with POST /api/v1/login/password as a local user, or via OIDC when configured. The cookie is HttpOnly and lasts 24 hours.

Try requests

In the API reference of your console (Help > API reference), Try it sends each request to that console, with your session. The public docs site has no console, so it shows no Try it panel: open the API reference in your console to try requests.

Roles

Each session has a role: none, viewer, operator or admin. Each operation needs a lowest role, and a session with a lower role gets 403. The token login is always admin.

A local user can also have a grant on a database service: viewer or operator. For an operation on that service, the role is the higher of the default role and the grant. A user with the default role none sees only the services of the grants: lists show only these services, and the other operations answer 403.

Errors

Errors are JSON with a stable shape:

{“error”: “human-readable message”, “details”: [“optional”, “specifics”]}

Validation failures return 422 with per-field messages in details. The restore endpoint’s 422 additionally carries nearest_consistent_point when a requested recovery time falls outside provable backup coverage.

Asynchronous operations

Mutating infrastructure (deploy, restore, backup trigger, config applies, stanza deletes) returns 202 Accepted immediately and runs as a tracked workflow. Follow progress via the workflows endpoints; raw Ansible output streams from /workflows/{id}/stdout and a parsed NDJSON event stream from /database-services/{id}/logs.

Spec

This page is generated from the running binary: /api/v1/openapi.json and /api/v1/openapi.yaml always match the deployed code.

Version dev
Base URLhttps://console.example.com

system

Console feature flags, build version, SSH public key, and mesh overlay status.

auth

Login (token, local user, OIDC), logout, the own password change, session identity and role, and the reverse-proxy forward_auth check.

servers

Server registration (mesh enrollment), specs, SSH checks, and per-server backup operations.

stanzas

pgBackRest stanza inspection and lifecycle: orphaned stanzas, adoption, repo deletion.

database-services

PostgreSQL + TimescaleDB services: CRUD, deploy, backups, restore, health probes, Patroni actions, and logs.

dcs-clusters

Standalone etcd (DCS) clusters backing advanced HA topologies.

livesync

Continuous database replication via timescale/live-sync: sessions, source preflight, and replication health.

workflows

Tracked Ansible runs: listing, inspection, log streaming, kill, and cleanup.

reports

Support bundles: async collection, download, and lifecycle.

alerts

Alert rule state, notification destinations, and configurable thresholds.

users

Users: an admin creates local users, sets their role, disables them, and resets their password. The first SSO login adds an OIDC user.

audit

The audit log: who changed what, and each login.

settings

Console settings: single sign-on (OIDC).

remote-assist

Remote assist: a session in which Tiger Data support uses this console.

console-backup

metrics

license