# TimescaleDB Enterprise > Deploy and manage PostgreSQL and TimescaleDB on your own servers, with high availability, backups, monitoring and air-gapped installs. TimescaleDB Enterprise is a self-hosted console. It deploys and manages PostgreSQL and TimescaleDB on your own Linux servers, with high availability, backups and monitoring. To install the console on a Linux host with Docker, run `curl -fsSL https://enterprise.tigerdata.com/install/timescale-enterprise.sh | sh`. ## Get started - [Introduction](https://enterprise.tigerdata.com/docs): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/reference-architectures): Supported topologies and placement rules for VMs and bare metal: Standard, Standard HA and Advanced HA, the connection path and the network. ## Install - [Installation](https://enterprise.tigerdata.com/docs/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ## Console - [Configuration](https://enterprise.tigerdata.com/docs/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and activate an air-gapped console. - [Remote assist](https://enterprise.tigerdata.com/docs/remote-assist): Let Tiger Data support use your console for a set time: read only by default, never your credentials, and each request in the audit log. ## Servers - [Servers](https://enterprise.tigerdata.com/docs/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ## Database services - [Database services](https://enterprise.tigerdata.com/docs/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ## Backups - [Backups](https://enterprise.tigerdata.com/docs/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ## Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ## LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ## Operations - [Operations](https://enterprise.tigerdata.com/docs/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. ### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. ### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ## Changelog - [Release notes](https://enterprise.tigerdata.com/docs/changelog): What is new, fixed and changed in each release of TimescaleDB Enterprise, newest first, with the upgrade notes for each release. - [2026.11.15-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.15-beta): Upgrade a service that LiveSync uses, with fewer actions blocked by a running session, small UI improvements, and fixes for deploy and rebuild. - [2026.11.14-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.14-beta): Bug fixes: a deploy waits for the package manager of a server, and applying a licence works in a rare case. Upgrade with the installer. - [2026.11.13-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.13-beta): Bug fixes and small improvements to the console, the installer and the docs. Upgrade with the installer, as for each earlier release. - [2026.11.12-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.12-beta): The Ignition Enterprise Historian connects to a demo again: a demo also serves the console over plain HTTP on port 8080, shown as the Historian URL. - [2026.11.11-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.11-beta): Remote assist, a license grant for each database, a simpler air-gapped exchange, a new server page, more charts and a setting to show times in UTC. - [2026.11.10-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.10-beta): TimescaleDB Toolkit 1.27.0 is the recommended version, and the right-click menu of the SQL editor has a background and no Paste that cannot work. - [2026.11.9-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.9-beta): The SQL browser runs queries over plain HTTP on any address, and the installer accepts the standalone docker-compose v2, for example with Colima. - [2026.11.8-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.8-beta): Simpler management of an existing demo, a console can start without an upgrade, and the API reference has a version for each release. - [2026.11.7-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.7-beta): Fixes for the Ignition integration in demo mode, the sudo password prompt of the installer, and the screenshots of archived docs versions. - [2026.11.6-beta](https://enterprise.tigerdata.com/docs/changelog/2026.11.6-beta): Simpler integration with the Ignition 2027 Enterprise Historian, telemetry improvements, and a more reliable demo mode on computers with a VPN. ## Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… ### system - [Get the console clock](https://enterprise.tigerdata.com/docs/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. ### auth - [Check the session](https://enterprise.tigerdata.com/docs/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. ### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Get server software and state](https://enterprise.tigerdata.com/docs/reference/servers/get-server-facts): Returns the software of a server (OS, versions, components) and… Reference for the GET /api/v1/servers/{id}/facts endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. ### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. ### database-services - [List database services](https://enterprise.tigerdata.com/docs/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-grant): Read the fingerprint of a database and whether it… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. ### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. ### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. ### workflows - [List workflows](https://enterprise.tigerdata.com/docs/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. ### reports - [List support reports](https://enterprise.tigerdata.com/docs/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. ### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. ### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. ### audit - [List the audit log](https://enterprise.tigerdata.com/docs/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. ### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. ### remote-assist - [Get the remote assist status](https://enterprise.tigerdata.com/docs/reference/remote-assist/get-remote-assist): The state of remote assist, the open or the last session, and the… Reference for the GET /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [Turn on remote assist](https://enterprise.tigerdata.com/docs/reference/remote-assist/start-remote-assist): Open a session in which Tiger Data support can use this console,… Reference for the POST /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [End remote assist](https://enterprise.tigerdata.com/docs/reference/remote-assist/end-remote-assist): End the open session now. The tunnel closes, and each engineer… Reference for the POST /api/v1/remote-assist/end endpoint in the TimescaleDB Enterprise API. - [List support requests](https://enterprise.tigerdata.com/docs/reference/remote-assist/list-remote-assist-requests): The requests of Tiger Data support in the open or the last… Reference for the GET /api/v1/remote-assist/requests endpoint in the TimescaleDB Enterprise API. ### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. ### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. ### license - [Get current license status](https://enterprise.tigerdata.com/docs/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Import an air-gapped bundle](https://enterprise.tigerdata.com/docs/reference/license/import-license-bundle): Apply a bundle file from support in one step: add the license file,… Reference for the POST /api/v1/license/bundle endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Export an air-gapped request](https://enterprise.tigerdata.com/docs/reference/license/export-license-request): Make the request file of an air-gapped install: the install ID,… Reference for the POST /api/v1/license/request endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.14-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.14-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: Standard, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and activate an air-gapped console. - [Remote assist](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/remote-assist): Let Tiger Data support use your console for a set time: read only by default, never your credentials, and each request in the audit log. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Get server software and state](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/get-server-facts): Returns the software of a server (OS, versions, components) and… Reference for the GET /api/v1/servers/{id}/facts endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-grant): Read the fingerprint of a database and whether it… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### remote-assist - [Get the remote assist status](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/remote-assist/get-remote-assist): The state of remote assist, the open or the last session, and the… Reference for the GET /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [Turn on remote assist](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/remote-assist/start-remote-assist): Open a session in which Tiger Data support can use this console,… Reference for the POST /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [End remote assist](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/remote-assist/end-remote-assist): End the open session now. The tunnel closes, and each engineer… Reference for the POST /api/v1/remote-assist/end endpoint in the TimescaleDB Enterprise API. - [List support requests](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/remote-assist/list-remote-assist-requests): The requests of Tiger Data support in the open or the last… Reference for the GET /api/v1/remote-assist/requests endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Import an air-gapped bundle](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/import-license-bundle): Apply a bundle file from support in one step: add the license file,… Reference for the POST /api/v1/license/bundle endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Export an air-gapped request](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/export-license-request): Make the request file of an air-gapped install: the install ID,… Reference for the POST /api/v1/license/request endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.14-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.13-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.13-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: Standard, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and activate an air-gapped console. - [Remote assist](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/remote-assist): Let Tiger Data support use your console for a set time: read only by default, never your credentials, and each request in the audit log. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Get server software and state](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/get-server-facts): Returns the software of a server (OS, versions, components) and… Reference for the GET /api/v1/servers/{id}/facts endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-grant): Read the fingerprint of a database and whether it… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### remote-assist - [Get the remote assist status](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/remote-assist/get-remote-assist): The state of remote assist, the open or the last session, and the… Reference for the GET /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [Turn on remote assist](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/remote-assist/start-remote-assist): Open a session in which Tiger Data support can use this console,… Reference for the POST /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [End remote assist](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/remote-assist/end-remote-assist): End the open session now. The tunnel closes, and each engineer… Reference for the POST /api/v1/remote-assist/end endpoint in the TimescaleDB Enterprise API. - [List support requests](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/remote-assist/list-remote-assist-requests): The requests of Tiger Data support in the open or the last… Reference for the GET /api/v1/remote-assist/requests endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Import an air-gapped bundle](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/import-license-bundle): Apply a bundle file from support in one step: add the license file,… Reference for the POST /api/v1/license/bundle endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Export an air-gapped request](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/export-license-request): Make the request file of an air-gapped install: the install ID,… Reference for the POST /api/v1/license/request endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.13-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.12-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.12-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: Standard, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and activate an air-gapped console. - [Remote assist](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/remote-assist): Let Tiger Data support use your console for a set time: read only by default, never your credentials, and each request in the audit log. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Get server software and state](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/get-server-facts): Returns the software of a server (OS, versions, components) and… Reference for the GET /api/v1/servers/{id}/facts endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-grant): Read the fingerprint of a database and whether it… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### remote-assist - [Get the remote assist status](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/remote-assist/get-remote-assist): The state of remote assist, the open or the last session, and the… Reference for the GET /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [Turn on remote assist](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/remote-assist/start-remote-assist): Open a session in which Tiger Data support can use this console,… Reference for the POST /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [End remote assist](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/remote-assist/end-remote-assist): End the open session now. The tunnel closes, and each engineer… Reference for the POST /api/v1/remote-assist/end endpoint in the TimescaleDB Enterprise API. - [List support requests](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/remote-assist/list-remote-assist-requests): The requests of Tiger Data support in the open or the last… Reference for the GET /api/v1/remote-assist/requests endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Import an air-gapped bundle](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/import-license-bundle): Apply a bundle file from support in one step: add the license file,… Reference for the POST /api/v1/license/bundle endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Export an air-gapped request](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/export-license-request): Make the request file of an air-gapped install: the install ID,… Reference for the POST /api/v1/license/request endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.12-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.11-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.11-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: Standard, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and activate an air-gapped console. - [Remote assist](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/remote-assist): Let Tiger Data support use your console for a set time: read only by default, never your credentials, and each request in the audit log. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Get server software and state](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/get-server-facts): Returns the software of a server (OS, versions, components) and… Reference for the GET /api/v1/servers/{id}/facts endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-grant): Read the fingerprint of a database and whether it… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### remote-assist - [Get the remote assist status](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/remote-assist/get-remote-assist): The state of remote assist, the open or the last session, and the… Reference for the GET /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [Turn on remote assist](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/remote-assist/start-remote-assist): Open a session in which Tiger Data support can use this console,… Reference for the POST /api/v1/remote-assist endpoint in the TimescaleDB Enterprise API. - [End remote assist](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/remote-assist/end-remote-assist): End the open session now. The tunnel closes, and each engineer… Reference for the POST /api/v1/remote-assist/end endpoint in the TimescaleDB Enterprise API. - [List support requests](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/remote-assist/list-remote-assist-requests): The requests of Tiger Data support in the open or the last… Reference for the GET /api/v1/remote-assist/requests endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Import an air-gapped bundle](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/import-license-bundle): Apply a bundle file from support in one step: add the license file,… Reference for the POST /api/v1/license/bundle endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Export an air-gapped request](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/export-license-request): Make the request file of an air-gapped install: the install ID,… Reference for the POST /api/v1/license/request endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.11-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.10-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.10-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: single node, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and bind a license on an air-gapped console. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-grant): Read the license grant a database holds, and how to… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Set the license grant](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/set-database-service-grant): Write a license grant obtained out of band. Reference for the POST /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Give a major upgrade grant](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/paste-database-service-major-upgrade-grant): An air-gapped console cannot mint the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/grant endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Get a license binding](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/get-license-bind): Read whether an air-gapped license is bound to this console. Reference for the GET /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Bind an air-gapped license](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/set-license-bind): Bind an air-gapped license to this console install. Reference for the POST /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.10-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.9-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.9-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: single node, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and bind a license on an air-gapped console. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-grant): Read the license grant a database holds, and how to… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Set the license grant](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/set-database-service-grant): Write a license grant obtained out of band. Reference for the POST /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Give a major upgrade grant](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/paste-database-service-major-upgrade-grant): An air-gapped console cannot mint the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/grant endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Get a license binding](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/get-license-bind): Read whether an air-gapped license is bound to this console. Reference for the GET /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Bind an air-gapped license](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/set-license-bind): Bind an air-gapped license to this console install. Reference for the POST /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.9-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.8-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.8-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: single node, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and bind a license on an air-gapped console. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-grant): Read the license grant a database holds, and how to… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Set the license grant](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/set-database-service-grant): Write a license grant obtained out of band. Reference for the POST /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Give a major upgrade grant](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/paste-database-service-major-upgrade-grant): An air-gapped console cannot mint the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/grant endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Get a license binding](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/get-license-bind): Read whether an air-gapped license is bound to this console. Reference for the GET /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Bind an air-gapped license](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/set-license-bind): Bind an air-gapped license to this console install. Reference for the POST /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.8-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.7-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.7-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: single node, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and bind a license on an air-gapped console. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-grant): Read the license grant a database holds, and how to… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Set the license grant](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/set-database-service-grant): Write a license grant obtained out of band. Reference for the POST /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Give a major upgrade grant](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/paste-database-service-major-upgrade-grant): An air-gapped console cannot mint the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/grant endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Get a license binding](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/get-license-bind): Read whether an air-gapped license is bound to this console. Reference for the GET /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Bind an air-gapped license](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/set-license-bind): Bind an air-gapped license to this console install. Reference for the POST /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.7-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.6-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.6-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: single node, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and bind a license on an air-gapped console. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-grant): Read the license grant a database holds, and how to… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Set the license grant](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/set-database-service-grant): Write a license grant obtained out of band. Reference for the POST /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Give a major upgrade grant](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/paste-database-service-major-upgrade-grant): An air-gapped console cannot mint the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/grant endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Get a license binding](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/get-license-bind): Read whether an air-gapped license is bound to this console. Reference for the GET /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Bind an air-gapped license](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/set-license-bind): Bind an air-gapped license to this console install. Reference for the POST /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.6-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## v2026.11.5-beta (archived) ### Get started - [Introduction](https://enterprise.tigerdata.com/docs/v2026.11.5-beta): A self-hosted console that deploys and manages PostgreSQL + TimescaleDB on your own servers, with HA, backups, monitoring and air-gapped installs. - [Features](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/features): The main features of the TimescaleDB Enterprise console, by area: services, HA, backups, upgrades, monitoring, security and licensing. - [Demo mode](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/demo-mode): Try the console on one computer, with demo servers as Docker containers: start, stop and reset a demo, connect, and convert it to production. - [Reference architectures](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference-architectures): Supported topologies and placement rules for VMs and bare metal: single node, Standard HA and Advanced HA, the connection path and the network. ### Install - [Installation](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/installation): Install the console on a Linux host with the installer: requirements, the installer menu, a bundle install and the server packages. - [Upgrade](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/upgrade): Upgrade the console to a new release with the installer: online, bundle and airgapped installs, and the server packages of the new release. - [Uninstall](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/uninstall): Remove the console from its host with the installer, what the uninstall deletes, and what stays for a later restore. - [Airgapped install](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/installation-airgapped): Install and upgrade a console that has no internet access from one offline/airgapped package, and add a server OS to an air-gapped console later. - [Installer options](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/installer-options): The command line options and environment variables of the installer, and where to check the signature of a release before you install it. - [Verify a release](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/verify-a-release): Check the signatures and the checksums of the installer, the console image, the server packages and an offline/airgapped package of a release. ### Console - [Configuration](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/configuration): Set TLS, the console URL, the mesh range and the secrets of the console in .env, and the update check, telemetry and the console clock. - [Users and roles](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/users-and-roles): Log in, give each user a role, give access to single services, set up two-factor authentication, and read and export the audit log. - [Single sign-on](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/single-sign-on): Let users log in with your OIDC identity provider, for example Okta or Microsoft Entra ID, map groups to roles, and turn off the local login. - [Console backups](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/console-backups): Back up the console to a local directory or to S3-compatible storage, on a schedule or on demand, with a recovery key and retention rules. - [Licensing](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/licensing): Add a license or start a trial, see what a license covers and limits, keep your services licensed, and bind a license on an air-gapped console. ### Servers - [Servers](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/servers): The requirements of a database, DCS or backup server, and how to enroll a server into the private mesh of the console. - [Server packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/server-packages): The server packages of the console: load, check and remove them, and what happens with server packages of an earlier release. - [Time sync](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/time-sync): How the servers take their time from the console host, the Time sync page, and the preflight rows of the clock check. - [Manage servers](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/manage-servers): Test, rename, re-enroll, clean up and delete servers, find the cause of Needs cleanup, and grow the storage of a server in use. ### Database services - [Database services](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services): Create, deploy and remove PostgreSQL + TimescaleDB database services on enrolled servers, and read the health and the pages of a service. - [High availability](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/high-availability): High-availability topologies with Patroni and etcd, the virtual IP and how to change it, and automatic failover and manual switchover. - [Connect](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/connect): Find the connection string, host and port of a database service, in JDBC, URI or psql format, and the other endpoints of an HA service. - [Extensions](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/extensions): The PostgreSQL extensions that the console installs, how to add or drop an extension on a service, and how to see the extension versions. - [SQL browser](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/sql): Run SQL against a database service in the console, read-only by default, browse its schema, and see the query limits and the query history. - [External DCS](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/external-dcs): Run etcd on a separate DCS cluster for Advanced HA services, check the health of the cluster, redeploy it, and replace a member server. - [Settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/settings): Which PostgreSQL, TimescaleDB, PgBouncer and HAProxy settings you can change, which settings the console owns, and how a change applies. - [Service operations](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/operations): Read the history of a database service and use Summary, Output, Errors and Inventory to inspect an operation run. - [Overview](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/overview): Read a database service's health and topology, find connection details, and use node actions and status banners. - [Database service admin](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/database-services/admin): Run service maintenance, deploy or remove a service, and manage console-user access from the Database service admin tab. ### Backups - [Backups](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/backups): Back up a database service with pgBackRest to a local and a remote copy, on a schedule or on demand, with retention and checksum checks. - [Restore](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/backups/restore): Restore a database service in place, or restore a backup into a new service, to the latest backup or to a point in time. ### Monitoring - [Metrics](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/monitoring): Metrics of each server and database service on the Monitoring tab, metrics retention, PromQL queries, and federation into your own Prometheus. - [Alerts](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/alerts): Built-in alert rules, notifications by Slack, Teams, webhook or email, a heartbeat for the console, and alert settings for each database service. - [Logs and support](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/logs-and-support): Read the logs of a database service, turn on verbose deploy logs, run diagnostics, and make a support report to send to Tiger Data support. ### LiveSync - [LiveSync](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/livesync): Continuously replicate PostgreSQL and TimescaleDB data between managed services and external databases with logical replication and LiveSync. - [Create a session](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/livesync/setup): Prepare the source and target databases, managed or external, and create a LiveSync session in the console, with one or more sessions per source. - [Monitor and manage](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/livesync/operations): Check replication, change the table selection, stop, start or delete a LiveSync session, and fix failures after HA or server failures. - [Configuration and diagnostics](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/livesync/configuration): LiveSync settings in TimescaleDB Enterprise, capacity of the server that runs it, credentials, and the SQL check for slot lag. ### Operations - [Operations](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations): Recovery runbooks for HA services and the console, with symptoms and recovery times, plus maintenance, backup and restore procedures. #### Failures - [Disk full on the primary](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/disk-full-primary): Stop writes, free space with a balloon file or a larger disk, and confirm the recovery when the data disk of the primary of a service is full. - [Disk full on a replica](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/disk-full-replica): Free space on an HA replica with a full data disk, confirm that it streams from the primary again, and rebuild the replica if it cannot catch up. - [Balloon files](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/balloon-file): Delete a reserved placeholder file from the console or over SSH to free space during a disk-full incident, then recreate the emergency reserve. - [Node power loss](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/node-power-loss): Bring back a PostgreSQL server of an HA service after a power loss, confirm that it rejoins as a replica, and check for lost commits. - [Network partition](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/network-partition): Bring back an HA server that lost its network link, confirm that it rejoins as a replica, and check that the service has one primary only. - [Site outage and recovery](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/site-outage): Bring back an HA service after all of its servers lost power at the same time, confirm that it has one primary, and check for lost commits. - [Console outage](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/console-outage): Recover a stopped console, a full console disk, or a console database that is read-only or damaged, and see what keeps working meanwhile. - [etcd disk full](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/dcs-disk-full): Recover an etcd (DCS) member whose data disk is full: free space without deleting etcd data, let the member rejoin, and confirm quorum. - [HAProxy or PgBouncer failure](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/proxy-failure): Recover a stopped HAProxy or PgBouncer on a node of an HA service, and check that the VIP and the pooled and direct ports serve again. - [Backups found corrupt pages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/backups-found-corrupt-pages): A backup found invalid page checksums. Find the corrupt files, get a clean copy of the data from a replica or a backup, and check the result. #### Maintenance - [Resize a server in place](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/resize-in-place): Add CPU or RAM to the servers of a service one server at a time, then retune the PostgreSQL settings of the service to the new size. - [Replace a server](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/replace-a-server): Move a member of an HA service or a DCS cluster to a different server: release the slot, fill it with a free server, and rebuild the member. - [Change IP addresses](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/change-ip-addresses): Give a server or the console a new LAN IP address, then update the clients, the VIP and the console URL that use the old address. - [Upgrade a service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/upgrade-a-service): Move PostgreSQL, the extensions, Patroni and pgBouncer of a service to newer versions from the Updates tab, with a check and a rolling upgrade. - [Upgrade the PostgreSQL major](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/upgrade-the-postgresql-major): Move a service to a newer PostgreSQL major, for example from 17 to 18, from the Updates tab: a Check, a fresh full backup, and a maintenance window. - [Restore the console](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/operations/restore-the-console): Restore the console from a console backup, on a new host after the loss of the console host or in place, and check the servers and services. ### Reference - [TimescaleDB Enterprise API](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference): Management API for the TimescaleDB Enterprise Console: it registers bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB database… #### system - [Get the console clock](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/get-console-clock): The console compares the clock of its host with the public NTP pool… Reference for the GET /api/v1/console/clock endpoint in the TimescaleDB Enterprise API. - [Get the time sync state](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/get-time-sync): The console serves the clock of its host to the servers over the… Reference for the GET /api/v1/console/time-sync endpoint in the TimescaleDB Enterprise API. - [Get console feature flags](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/get-info): Returns the feature flags of the console, the metrics engine state, the build… Reference for the GET /api/v1/info endpoint in the TimescaleDB Enterprise API. - [Get the mesh status](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/get-mesh-status): Get WireGuard mesh overlay status. Reference for the GET /api/v1/mesh/status endpoint in the TimescaleDB Enterprise API. - [List loaded packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/list-packs): The server packages in the data volume, one pack file per OS version and… Reference for the GET /api/v1/packs endpoint in the TimescaleDB Enterprise API. - [List release packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/list-available-packs): The packs of the release of this console at the pack source… Reference for the GET /api/v1/packs/available endpoint in the TimescaleDB Enterprise API. - [Preview server packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/get-available-pack-summary): For one pack of the release of this console at the… Reference for the GET /api/v1/packs/available/{name}/summary endpoint in the TimescaleDB Enterprise API. - [Download server packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/download-packs): Downloads each named pack of the release of this console from the… Reference for the POST /api/v1/packs/download endpoint in the TimescaleDB Enterprise API. - [Remove unused packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/remove-unused-packs): Removes each pack that no server installed packages from… Reference for the POST /api/v1/packs/remove-unused endpoint in the TimescaleDB Enterprise API. - [Verify server packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/rescan-packs): Reads the pack directory and verifies every pack again, for example… Reference for the POST /api/v1/packs/rescan endpoint in the TimescaleDB Enterprise API. - [Upload server packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/upload-pack): Loads the server packages of the request body, as… Reference for the POST /api/v1/packs/upload endpoint in the TimescaleDB Enterprise API. - [Remove server packages](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/remove-pack): Deletes the pack from the data volume. The console refuses (409)… Reference for the DELETE /api/v1/packs/{name} endpoint in the TimescaleDB Enterprise API. - [Show package contents](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/get-pack-summary): For one verified pack: each PostgreSQL major with its minor,… Reference for the GET /api/v1/packs/{name}/summary endpoint in the TimescaleDB Enterprise API. - [List server components](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/list-server-components): The files that the console gives to every server, from the… Reference for the GET /api/v1/server-components endpoint in the TimescaleDB Enterprise API. - [Get build version](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/get-version): Returns the build version of the console, and the result of the update… Reference for the GET /api/v1/version endpoint in the TimescaleDB Enterprise API. - [Check for a newer release](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/system/check-for-update): Reads latest.json of the docs site now and returns the result. A… Reference for the POST /api/v1/version/check endpoint in the TimescaleDB Enterprise API. #### auth - [Check the session](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/auth-check): Session check for reverse-proxy forward_auth. Reference for the GET /api/v1/auth/check endpoint in the TimescaleDB Enterprise API. - [Get your session identity](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/get-auth-me): Get the current session identity. Reference for the GET /api/v1/auth/me endpoint in the TimescaleDB Enterprise API. - [List login methods](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/get-auth-methods): List enabled login methods and terms state. Reference for the GET /api/v1/auth/methods endpoint in the TimescaleDB Enterprise API. - [Change your password](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/change-own-password): Ends the other sessions of the user and sets a new session cookie. Reference for the POST /api/v1/auth/password endpoint in the TimescaleDB Enterprise API. - [Get your two-factor state](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/get-own-two-factor): Get the two-factor state of the current local user. Reference for the GET /api/v1/auth/two-factor endpoint in the TimescaleDB Enterprise API. - [Turn off your two-factor](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/disable-own-two-factor): Needs the current password and a current code. Not… Reference for the POST /api/v1/auth/two-factor/disable endpoint in the TimescaleDB Enterprise API. - [Start TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/start-two-factor-enrolment): Returns a new secret. It is not active until the user… Reference for the POST /api/v1/auth/two-factor/enrolment endpoint in the TimescaleDB Enterprise API. - [Confirm TOTP enrolment](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/confirm-two-factor-enrolment): Turns two-factor on and returns 10 recovery… Reference for the POST /api/v1/auth/two-factor/enrolment/confirm endpoint in the TimescaleDB Enterprise API. - [Replace your recovery codes](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/regenerate-recovery-codes): Needs a current code. The old codes stop working. Reference for the POST /api/v1/auth/two-factor/recovery-codes endpoint in the TimescaleDB Enterprise API. - [Give the second factor](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/verify-second-factor): Send a code of the authenticator app, or an unused recovery… Reference for the POST /api/v1/auth/two-factor/verify endpoint in the TimescaleDB Enterprise API. - [Log in with the auth token](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/login): Log in with the console auth token. Reference for the POST /api/v1/login endpoint in the TimescaleDB Enterprise API. - [Log in as a local user](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/login-password): After 5 failed logins for one username (or 20 from one address),… Reference for the POST /api/v1/login/password endpoint in the TimescaleDB Enterprise API. - [Log out](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/auth/logout): Log out and clear the session cookie. Reference for the POST /api/v1/logout endpoint in the TimescaleDB Enterprise API. #### servers - [Get the enrollment script](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/get-enroll-script): Get the one-time server enrollment script. Reference for the GET /api/v1/enroll/{token} endpoint in the TimescaleDB Enterprise API. - [Download the mesh agent](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/get-enroll-agent): Download a mesh agent binary for server… Reference for the GET /api/v1/enroll/{token}/tailscale/{arch}/{binary} endpoint in the TimescaleDB Enterprise API. - [List servers](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/list-servers): Returns every registered server with its state. Set live to read the… Reference for the GET /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Register a server](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/create-server): Register a server. The response has the enroll command to run on the server. Reference for the POST /api/v1/servers endpoint in the TimescaleDB Enterprise API. - [Get demo server capacity](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/get-demo-capacity): The memory of Docker on the demo host, the demo servers that… Reference for the GET /api/v1/servers/demo-capacity endpoint in the TimescaleDB Enterprise API. - [List free servers](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/list-free-servers): Lists the enrolled servers that no database service, DCS cluster,… Reference for the GET /api/v1/servers/free endpoint in the TimescaleDB Enterprise API. - [Delete a server](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/delete-server): Deletes a server. Rejected with 409 while the server fills a member… Reference for the DELETE /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Rename a server](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/update-server): Changes the display name of a server. The name cannot be empty.… Reference for the PATCH /api/v1/servers/{id} endpoint in the TimescaleDB Enterprise API. - [Trigger a server backup](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/trigger-server-backup): Trigger a pgbackrest backup on a server. Reference for the POST /api/v1/servers/{id}/backup endpoint in the TimescaleDB Enterprise API. - [Get on-disk backup state](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/get-server-backup-state): Read on-disk backup config state. Reference for the GET /api/v1/servers/{id}/backup-state endpoint in the TimescaleDB Enterprise API. - [List backups on a server](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/list-server-backups): List pgbackrest backups on a server. Reference for the GET /api/v1/servers/{id}/backups endpoint in the TimescaleDB Enterprise API. - [Stream a demo console](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/get-demo-server-console): Raw terminal bytes (application/octet-stream): the boot… Reference for the GET /api/v1/servers/{id}/demo-console endpoint in the TimescaleDB Enterprise API. - [Make a new enroll command](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/regenerate-enroll-command): Mint a fresh enroll command for an existing server. Reference for the POST /api/v1/servers/{id}/enroll-command endpoint in the TimescaleDB Enterprise API. - [Retry a server cleanup](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/retry-server-cleanup): Runs the cleanup of a server that needs cleanup… Reference for the POST /api/v1/servers/{id}/retry-cleanup endpoint in the TimescaleDB Enterprise API. - [Get server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/get-server-specs): Get stored server hardware specs. Reference for the GET /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [Probe server hardware specs](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/refresh-server-specs): Probe server hardware specs live and persist the result. Reference for the POST /api/v1/servers/{id}/specs endpoint in the TimescaleDB Enterprise API. - [List stanzas on a server](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/list-server-stanzas): List stanzas with a repo on a server. Reference for the GET /api/v1/servers/{id}/stanzas endpoint in the TimescaleDB Enterprise API. - [Test SSH to a server](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/servers/test-ssh): Test SSH connectivity to a server. Reference for the POST /api/v1/servers/{id}/test-ssh endpoint in the TimescaleDB Enterprise API. #### stanzas - [Adopt an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/stanzas/adopt-stanza): Adopt an untracked on-disk stanza as… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt endpoint in the TimescaleDB Enterprise API. - [Delete an untracked stanza](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/stanzas/delete-untracked-stanza): Delete an untracked on-disk stanza… Reference for the POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete endpoint in the TimescaleDB Enterprise API. - [Get a stanza by name](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/stanzas/get-stanza-by-name): Get a stanza by name. Reference for the GET /api/v1/stanzas/by-name/{name} endpoint in the TimescaleDB Enterprise API. - [List orphaned stanzas](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/stanzas/list-orphaned-stanzas): List orphaned stanzas. Reference for the GET /api/v1/stanzas/orphaned endpoint in the TimescaleDB Enterprise API. - [Delete a stanza's repo data](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/stanzas/delete-stanza-repo): Delete a stanza's backup data on a repo. Reference for the POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete endpoint in the TimescaleDB Enterprise API. #### database-services - [List database services](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/list-database-services): List database services. Reference for the GET /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Create a database service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/create-database-service): Create a database service. Reference for the POST /api/v1/database-services endpoint in the TimescaleDB Enterprise API. - [Run pre-create checks](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/preflight-database-service-plan): Run pre-create prerequisite checks on candidate… Reference for the POST /api/v1/database-services/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a database service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/delete-database-service): Delete a database service. Reference for the DELETE /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Get a database service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service): Get a database service. Reference for the GET /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [Update a database service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/update-database-service): set_extensions takes the extension list, or an object with… Reference for the PATCH /api/v1/database-services/{id} endpoint in the TimescaleDB Enterprise API. - [List users with access](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/list-database-service-access): Each user (local or OIDC) whose role on the service… Reference for the GET /api/v1/database-services/{id}/access endpoint in the TimescaleDB Enterprise API. - [Apply the backup config](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/apply-database-service-backup-config): Apply the backup configuration to the… Reference for the POST /api/v1/database-services/{id}/apply-backup-config endpoint in the TimescaleDB Enterprise API. - [Apply the exporters config](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/apply-database-service-exporters-config): Apply the exporters configuration to… Reference for the POST /api/v1/database-services/{id}/apply-exporters-config endpoint in the TimescaleDB Enterprise API. - [Apply the license caps](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/apply-database-service-license-caps): Apply the license vCPU and memory caps… Reference for the POST /api/v1/database-services/{id}/apply-license-caps endpoint in the TimescaleDB Enterprise API. - [Trigger a pgbackrest backup](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/trigger-database-service-backup): Trigger a pgbackrest backup. Reference for the POST /api/v1/database-services/{id}/backup endpoint in the TimescaleDB Enterprise API. - [List config files](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/list-database-service-config-files): The console reads the config files after each… Reference for the GET /api/v1/database-services/{id}/config-files endpoint in the TimescaleDB Enterprise API. - [Check config file drift](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/check-database-service-config-drift): Runs one SSH command on each PostgreSQL… Reference for the POST /api/v1/database-services/{id}/config-files/check endpoint in the TimescaleDB Enterprise API. - [Get a config file version](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-config-file-version): The console replaces each password… Reference for the GET /api/v1/database-services/{id}/config-files/{snapshot} endpoint in the TimescaleDB Enterprise API. - [Write a debug bundle](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/create-database-service-debug-bundle): Write a debug bundle for a database service. Reference for the POST /api/v1/database-services/{id}/debug-bundle endpoint in the TimescaleDB Enterprise API. - [Deploy a database service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/deploy-database-service): Deploy a database service. Reference for the POST /api/v1/database-services/{id}/deploy endpoint in the TimescaleDB Enterprise API. - [Return to read-write](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/finish-database-service-emergency-space): Return the cluster to read-write and… Reference for the DELETE /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Get emergency space state](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-emergency-space): Read-only state and balloon files of a… Reference for the GET /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Free emergency space](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/start-database-service-emergency-space): Set the cluster read-only and delete one… Reference for the POST /api/v1/database-services/{id}/emergency-space endpoint in the TimescaleDB Enterprise API. - [Recreate balloon files](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/recreate-database-service-emergency-space): Recreate missing balloon files on… Reference for the POST /api/v1/database-services/{id}/emergency-space/recreate endpoint in the TimescaleDB Enterprise API. - [Create loaded extensions](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/create-database-service-extensions): Runs the create_extensions workflow for… Reference for the POST /api/v1/database-services/{id}/extensions/create endpoint in the TimescaleDB Enterprise API. - [List live extensions](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-live-extensions): Live PostgreSQL extensions for a database… Reference for the GET /api/v1/database-services/{id}/extensions/live endpoint in the TimescaleDB Enterprise API. - [Restart for new extensions](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/restart-database-service-extensions): Restarts PostgreSQL so that it loads the… Reference for the POST /api/v1/database-services/{id}/extensions/restart endpoint in the TimescaleDB Enterprise API. - [List extension dependents](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-extension-dependents): Reads, on the live leader, in… Reference for the GET /api/v1/database-services/{id}/extensions/{name}/dependents endpoint in the TimescaleDB Enterprise API. - [Drop an extension](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/drop-database-service-extension): Runs DROP EXTENSION on the live… Reference for the POST /api/v1/database-services/{id}/extensions/{name}/drop endpoint in the TimescaleDB Enterprise API. - [Get the license grant](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-grant): Read the license grant a database holds, and how to… Reference for the GET /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Set the license grant](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/set-database-service-grant): Write a license grant obtained out of band. Reference for the POST /api/v1/database-services/{id}/grant endpoint in the TimescaleDB Enterprise API. - [Get service health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-health): Reads the service now and returns the verdict… Reference for the GET /api/v1/database-services/{id}/health endpoint in the TimescaleDB Enterprise API. - [Get etcd health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-etcd-health): etcd health for a database service. Reference for the GET /api/v1/database-services/{id}/health/etcd endpoint in the TimescaleDB Enterprise API. - [Get HAProxy health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-haproxy-health): HAProxy health for a database service. Reference for the GET /api/v1/database-services/{id}/health/haproxy endpoint in the TimescaleDB Enterprise API. - [Get Patroni health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-patroni-health): Patroni health for a database service. Reference for the GET /api/v1/database-services/{id}/health/patroni endpoint in the TimescaleDB Enterprise API. - [Get pgBackRest health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-pgbackrest-health): Runs pgbackrest info for the stanza of the… Reference for the GET /api/v1/database-services/{id}/health/pgbackrest endpoint in the TimescaleDB Enterprise API. - [Get PgBouncer health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-pgbouncer-health): PgBouncer health for a database service. Reference for the GET /api/v1/database-services/{id}/health/pgbouncer endpoint in the TimescaleDB Enterprise API. - [Get balloon file health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-reserve-health): Emergency reserve (balloon files) per… Reference for the GET /api/v1/database-services/{id}/health/reserve endpoint in the TimescaleDB Enterprise API. - [Get PostgreSQL info](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-postgresql-info): PostgreSQL info for a database service. Reference for the GET /api/v1/database-services/{id}/info/postgresql endpoint in the TimescaleDB Enterprise API. - [Get observed versions](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-versions): Reads the PostgreSQL version and the available… Reference for the GET /api/v1/database-services/{id}/info/versions endpoint in the TimescaleDB Enterprise API. - [Dismiss LAN address changes](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/dismiss-database-service-lan-address-changes): The Overview does not show… Reference for the POST /api/v1/database-services/{id}/lan-address-changes/dismiss endpoint in the TimescaleDB Enterprise API. - [Change a service's license](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/set-database-service-license): Bind a database service to a different installed… Reference for the POST /api/v1/database-services/{id}/license endpoint in the TimescaleDB Enterprise API. - [Stream the workflow log](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-logs): Stream the latest workflow's log as NDJSON, following… Reference for the GET /api/v1/database-services/{id}/logs endpoint in the TimescaleDB Enterprise API. - [Get the major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-major-upgrade): Each PostgreSQL major of the pinned release… Reference for the GET /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Run a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/upgrade-database-service-major): Runs the plan of the last passed Check of the… Reference for the POST /api/v1/database-services/{id}/major-upgrade endpoint in the TimescaleDB Enterprise API. - [Check a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/check-database-service-major-upgrade): Checks the PostgreSQL major upgrade to… Reference for the POST /api/v1/database-services/{id}/major-upgrade/check endpoint in the TimescaleDB Enterprise API. - [Clean up a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/cleanup-database-service-major-upgrade): Removes the files of the earlier… Reference for the POST /api/v1/database-services/{id}/major-upgrade/cleanup endpoint in the TimescaleDB Enterprise API. - [Give a major upgrade grant](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/paste-database-service-major-upgrade-grant): An air-gapped console cannot mint the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/grant endpoint in the TimescaleDB Enterprise API. - [Roll back a major upgrade](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/rollback-database-service-major-upgrade): Rolls the service back to the… Reference for the POST /api/v1/database-services/{id}/major-upgrade/rollback endpoint in the TimescaleDB Enterprise API. - [Upgrade the backup stanza](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/stanza-database-service-major-upgrade): A rollback of a major upgrade (tier 1,… Reference for the POST /api/v1/database-services/{id}/major-upgrade/stanza endpoint in the TimescaleDB Enterprise API. - [Fail over to a node](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-patroni-failover): Fail the Patroni leader over to a node. Reference for the POST /api/v1/database-services/{id}/patroni/failover endpoint in the TimescaleDB Enterprise API. - [Restart Patroni on a node](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-patroni-restart): Restart Patroni on a node. Reference for the POST /api/v1/database-services/{id}/patroni/restart endpoint in the TimescaleDB Enterprise API. - [Rolling-restart the cluster](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-patroni-rolling-restart): Rolling-restart the Patroni cluster. Reference for the POST /api/v1/database-services/{id}/patroni/rolling-restart endpoint in the TimescaleDB Enterprise API. - [Switch over to a node](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-patroni-switchover): Switch the Patroni leader to a node. Reference for the POST /api/v1/database-services/{id}/patroni/switchover endpoint in the TimescaleDB Enterprise API. - [Run pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/preflight-database-service): Run pre-deployment prerequisite checks (advisory). Reference for the POST /api/v1/database-services/{id}/preflight endpoint in the TimescaleDB Enterprise API. - [Remove a database service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/remove-database-service): Remove a database service from its servers. Reference for the POST /api/v1/database-services/{id}/remove endpoint in the TimescaleDB Enterprise API. - [Restore a database service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/restore-database-service): Restore a database service from backups. Reference for the POST /api/v1/database-services/{id}/restore endpoint in the TimescaleDB Enterprise API. - [Fetch logs from a server](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-server-logs): Fetch a log snapshot from one of the… Reference for the GET /api/v1/database-services/{id}/servers/{serverId}/logs endpoint in the TimescaleDB Enterprise API. - [Rebuild a replaced member](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/rebuild-database-service-server): Clones the data from the leader… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Rebuild a replica](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/rebuild-database-service-replica): Empties the data… Reference for the POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica endpoint in the TimescaleDB Enterprise API. - [Get live settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-settings): Reads pg_settings in the database of the service on… Reference for the GET /api/v1/database-services/{id}/settings endpoint in the TimescaleDB Enterprise API. - [Apply settings changes](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/apply-database-service-settings): Validates the change set again on a new read… Reference for the POST /api/v1/database-services/{id}/settings/apply endpoint in the TimescaleDB Enterprise API. - [Discard pending settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/discard-database-service-settings): Sets each override that waits for its… Reference for the POST /api/v1/database-services/{id}/settings/discard endpoint in the TimescaleDB Enterprise API. - [Review settings changes](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/plan-database-service-settings): Validates a change set (or a YAML document of… Reference for the POST /api/v1/database-services/{id}/settings/plan endpoint in the TimescaleDB Enterprise API. - [Restart for new settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/restart-database-service-settings): Restarts PostgreSQL so that it uses the… Reference for the POST /api/v1/database-services/{id}/settings/restart endpoint in the TimescaleDB Enterprise API. - [Get overrides as YAML](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-settings-yaml): Gives the desired overrides as one YAML… Reference for the GET /api/v1/database-services/{id}/settings/yaml endpoint in the TimescaleDB Enterprise API. - [Fill a member slot](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/fill-database-service-slot): Puts a free server in the empty… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a member slot](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/release-database-service-slot): The server leaves the member… Reference for the POST /api/v1/database-services/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. - [Fetch query rows as Arrow](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-sql-arrow-results): Fetch a run's row data as gzipped… Reference for the POST /api/v1/database-services/{id}/sql/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a SQL query](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-sql-execute-query): Run a SQL query against a database… Reference for the POST /api/v1/database-services/{id}/sql/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Fetch the database schema](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-sql-schema): Fetch a database service's schema (tables,… Reference for the GET /api/v1/database-services/{id}/sql/api/schema endpoint in the TimescaleDB Enterprise API. - [Fetch read-only Arrow rows](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-sql-arrow-results-readonly): Fetch the row data of a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/arrowResults endpoint in the TimescaleDB Enterprise API. - [Run a read-only SQL query](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/database-service-sql-execute-query-readonly): Run a SQL query in a read-only… Reference for the POST /api/v1/database-services/{id}/sql/ro/api/executeQuery endpoint in the TimescaleDB Enterprise API. - [Get the available upgrade](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/get-database-service-upgrade): The items that the loaded server packages can move:… Reference for the GET /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Upgrade a database service](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/upgrade-database-service): Runs the resolved selection of the last Check (ADR… Reference for the POST /api/v1/database-services/{id}/upgrade endpoint in the TimescaleDB Enterprise API. - [Check a service upgrade](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/check-database-service-upgrade): Resolves the picked items, and checks the… Reference for the POST /api/v1/database-services/{id}/upgrade/check endpoint in the TimescaleDB Enterprise API. - [Change the virtual IP](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/change-database-service-vip): Change the virtual IP of an HA database service. Reference for the POST /api/v1/database-services/{id}/vip endpoint in the TimescaleDB Enterprise API. - [List available extensions](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/database-services/list-extensions): List the extensions that a database service can have. Reference for the GET /api/v1/extensions endpoint in the TimescaleDB Enterprise API. #### dcs-clusters - [List DCS clusters](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/list-dcs-clusters): Returns each standalone etcd (DCS) cluster with its name, status, and… Reference for the GET /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Create a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/create-dcs-cluster): Creates a standalone etcd (DCS) cluster on exactly 3 enrolled servers… Reference for the POST /api/v1/dcs-clusters endpoint in the TimescaleDB Enterprise API. - [Run DCS pre-deploy checks](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/preflight-dcs-cluster): Run pre-deployment prerequisite checks on candidate DCS… Reference for the POST /api/v1/dcs-clusters/preflight endpoint in the TimescaleDB Enterprise API. - [Delete a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/delete-dcs-cluster): Delete a DCS cluster. Reference for the DELETE /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/get-dcs-cluster): Get a DCS cluster. Reference for the GET /api/v1/dcs-clusters/{id} endpoint in the TimescaleDB Enterprise API. - [Get DCS cluster health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/get-dcs-cluster-health): Live etcd member, quorum and dependent service health of a… Reference for the GET /api/v1/dcs-clusters/{id}/health endpoint in the TimescaleDB Enterprise API. - [Redeploy a DCS cluster](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/redeploy-dcs-cluster): Runs the deploy of a standalone DCS cluster again on… Reference for the POST /api/v1/dcs-clusters/{id}/redeploy endpoint in the TimescaleDB Enterprise API. - [Rebuild a DCS member](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/rebuild-dcs-cluster-server): Replaces the etcd member of a DCS… Reference for the POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild endpoint in the TimescaleDB Enterprise API. - [Fill a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/fill-dcs-cluster-slot): Puts a free server in the empty etcd… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill endpoint in the TimescaleDB Enterprise API. - [Release a DCS member slot](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/dcs-clusters/release-dcs-cluster-slot): The server leaves the etcd member… Reference for the POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release endpoint in the TimescaleDB Enterprise API. #### livesync - [List livesync sessions](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/list-livesyncs): Returns each livesync session that the session can see, with its state.… Reference for the GET /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Create a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/create-livesync): Create a livesync session and deploy it. Reference for the POST /api/v1/livesync endpoint in the TimescaleDB Enterprise API. - [Check a source's wal_level](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/livesync-source-preflight): Check a managed source's wal_level. Reference for the GET /api/v1/livesync/source-preflight endpoint in the TimescaleDB Enterprise API. - [List source tables](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/livesync-source-tables): List a managed source's publishable tables. Reference for the GET /api/v1/livesync/source-tables endpoint in the TimescaleDB Enterprise API. - [Set wal_level to logical](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/livesync-enable-logical): Set wal_level=logical on a managed source and… Reference for the POST /api/v1/livesync/source/{id}/enable-logical endpoint in the TimescaleDB Enterprise API. - [Remove a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/delete-livesync): Remove a livesync session and its service. Reference for the DELETE /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/get-livesync): Get a livesync session. Reference for the GET /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Change livesync options](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/update-livesync): Change auto-add or create missing target tables. Reference for the PATCH /api/v1/livesync/{id} endpoint in the TimescaleDB Enterprise API. - [Get livesync health](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/livesync-health): Gather a livesync session's replication health. Reference for the GET /api/v1/livesync/{id}/health endpoint in the TimescaleDB Enterprise API. - [Start a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/start-livesync): Start a stopped or failed livesync session, or redeploy a… Reference for the POST /api/v1/livesync/{id}/start endpoint in the TimescaleDB Enterprise API. - [Stop a livesync session](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/stop-livesync): Stop a running livesync session. Reference for the POST /api/v1/livesync/{id}/stop endpoint in the TimescaleDB Enterprise API. - [List a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/livesync-tables): List a livesync session's published and unpublished source… Reference for the GET /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. - [Change a session's tables](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/livesync/publish-livesync-tables): Add or remove source tables on a livesync session and restart… Reference for the POST /api/v1/livesync/{id}/tables endpoint in the TimescaleDB Enterprise API. #### workflows - [List workflows](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/workflows/list-workflows): List workflows, newest first, paginated. Reference for the GET /api/v1/workflows endpoint in the TimescaleDB Enterprise API. - [Delete a workflow](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/workflows/delete-workflow): Delete a workflow and its logs. Reference for the DELETE /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/workflows/get-workflow): Returns one tracked workflow with its state, and the reason why it… Reference for the GET /api/v1/workflows/{id} endpoint in the TimescaleDB Enterprise API. - [Get a workflow's inventory](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/workflows/get-workflow-inventory): Get the Ansible inventory a workflow ran with. Reference for the GET /api/v1/workflows/{id}/inventory endpoint in the TimescaleDB Enterprise API. - [Kill a running workflow](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/workflows/kill-workflow): Kill a running workflow. Reference for the POST /api/v1/workflows/{id}/kill endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stderr](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/workflows/stream-workflow-stderr): Stream a workflow's stderr log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stderr endpoint in the TimescaleDB Enterprise API. - [Stream a workflow's stdout](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/workflows/stream-workflow-stdout): Stream a workflow's stdout log, following while it runs. Reference for the GET /api/v1/workflows/{id}/stdout endpoint in the TimescaleDB Enterprise API. #### reports - [List support reports](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/reports/list-reports): List support reports, newest first. Reference for the GET /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Create a support report](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/reports/create-report): Create a support report bundle (built asynchronously). Reference for the POST /api/v1/reports endpoint in the TimescaleDB Enterprise API. - [Delete a support report](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/reports/delete-report): Delete a support report. Reference for the DELETE /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Get a support report](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/reports/get-report): Get a support report's metadata. Reference for the GET /api/v1/reports/{id} endpoint in the TimescaleDB Enterprise API. - [Download a support report](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/reports/download-report): Download a ready report as a gzipped tarball. Reference for the GET /api/v1/reports/{id}/download endpoint in the TimescaleDB Enterprise API. #### alerts - [Get alert destinations](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/get-alert-delivery): Never returns a stored URL. The destinations are bearer credentials… Reference for the GET /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Set heartbeat destination](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/put-alert-delivery): Omitted keeps the stored value, an empty string clears it. Stored… Reference for the PUT /api/v1/alert-delivery endpoint in the TimescaleDB Enterprise API. - [Add an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/post-alert-destination): A global destination receives every alert of the… Reference for the POST /api/v1/alert-delivery/destinations endpoint in the TimescaleDB Enterprise API. - [Remove an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/delete-alert-destination): Refused with 409 when the destination is the… Reference for the DELETE /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Change an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/patch-alert-destination): The URL and the recipients cannot change: remove… Reference for the PATCH /api/v1/alert-delivery/destinations/{id} endpoint in the TimescaleDB Enterprise API. - [Test an alert destination](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/post-alert-destination-test): Reports the real HTTP result. A delivery… Reference for the POST /api/v1/alert-delivery/destinations/{id}/test endpoint in the TimescaleDB Enterprise API. - [List all alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/list-alert-overrides): Every database service is listed, also one that inherits everything. Reference for the GET /api/v1/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set operation silences](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/put-alert-planned-operations): On (the default): while an upgrade, a restart, a rebuild… Reference for the PUT /api/v1/alert-planned-operations endpoint in the TimescaleDB Enterprise API. - [Get global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/get-alert-rules): Get the global settings of every alert rule. Reference for the GET /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Change global alert rules](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/put-alert-rules): Partial: only the listed rules and the fields present change. Null… Reference for the PUT /api/v1/alert-rules endpoint in the TimescaleDB Enterprise API. - [Remove the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/delete-alert-smtp): Refused with 409 while an email destination exists. Remove those first. Reference for the DELETE /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/get-alert-smtp): Never returns the password: passwordSet reports whether one is stored. Reference for the GET /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Set the SMTP settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/put-alert-smtp): Replaces the settings. An omitted password keeps the stored one. The… Reference for the PUT /api/v1/alert-smtp endpoint in the TimescaleDB Enterprise API. - [Get alerts and their state](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/get-alerts): Everything the alerts page and the global indicator need, in one response.… Reference for the GET /api/v1/alerts endpoint in the TimescaleDB Enterprise API. - [Unmute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/delete-database-service-alert-mute): Expires the console's silences for the… Reference for the DELETE /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Mute a service's alerts](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/post-database-service-alert-mute): Creates an alert router silence on the service… Reference for the POST /api/v1/database-services/{id}/alert-mute endpoint in the TimescaleDB Enterprise API. - [Remove alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/delete-database-service-alert-overrides): The service then inherits the global… Reference for the DELETE /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/get-database-service-alert-overrides): Get the alert overrides of a database service. Reference for the GET /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Set service alert overrides](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/put-database-service-alert-overrides): The body is the full override: an unlisted… Reference for the PUT /api/v1/database-services/{id}/alert-overrides endpoint in the TimescaleDB Enterprise API. - [Get a service's alert rules](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/alerts/get-database-service-alert-rules): The same shape as GET /alert-rules, with the… Reference for the GET /api/v1/database-services/{id}/alert-rules endpoint in the TimescaleDB Enterprise API. #### users - [Get the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/get-two-factor-policy): Get the two-factor policy for local users. Reference for the GET /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [Set the two-factor policy](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/update-two-factor-policy): When on, each local user without TOTP must enrol at the next… Reference for the PUT /api/v1/two-factor-policy endpoint in the TimescaleDB Enterprise API. - [List the users](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/list-users): The local users and the OIDC users. The first SSO login of an OIDC user adds… Reference for the GET /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Create a local user](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/create-user): The user must change the initial password at the first login. Reference for the POST /api/v1/users endpoint in the TimescaleDB Enterprise API. - [Delete a user](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/delete-user): Ends the sessions of the user and deletes its grants. An admin cannot… Reference for the DELETE /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Change a user](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/update-user): A role change and a disable end the sessions of the user. An admin… Reference for the PATCH /api/v1/users/{id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's password](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/reset-user-password): Ends the sessions of the user. The user must change the… Reference for the POST /api/v1/users/{id}/password endpoint in the TimescaleDB Enterprise API. - [List a user's grants](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/list-user-service-grants): List the service grants of a user. Reference for the GET /api/v1/users/{id}/service-grants endpoint in the TimescaleDB Enterprise API. - [Remove a service grant](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/delete-user-service-grant): The change applies to the open sessions… Reference for the DELETE /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Set a user's service role](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/set-user-service-grant): The role on the service is the higher of the… Reference for the PUT /api/v1/users/{id}/service-grants/{service_id} endpoint in the TimescaleDB Enterprise API. - [Reset a user's two-factor](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/users/reset-user-two-factor): Deletes the TOTP secret and the recovery codes, and ends… Reference for the DELETE /api/v1/users/{id}/two-factor endpoint in the TimescaleDB Enterprise API. #### audit - [List the audit log](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/audit/list-audit-events): One row for each change request (each method other than GET) and each… Reference for the GET /api/v1/audit-events endpoint in the TimescaleDB Enterprise API. - [Export the audit log](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/audit/export-audit-events): Streams all the rows that match the filters, with no page… Reference for the GET /api/v1/audit-events/export endpoint in the TimescaleDB Enterprise API. - [Get an audit log row](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/audit/get-audit-event): The row with all its fields, for example the error text of a… Reference for the GET /api/v1/audit-events/{id} endpoint in the TimescaleDB Enterprise API. #### settings - [Get the deploy log setting](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/get-deploy-log-settings): Get the verbose deploy logs setting. Reference for the GET /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Set verbose deploy logs](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/set-deploy-log-settings): Applies to the next operation. An operation that runs keeps… Reference for the PUT /api/v1/settings/deploy-logs endpoint in the TimescaleDB Enterprise API. - [Get monitoring settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/get-monitoring-settings): Get the metrics retention and the metrics mirroring. Reference for the GET /api/v1/settings/monitoring endpoint in the TimescaleDB Enterprise API. - [Set metrics mirroring](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/set-metrics-mirroring): With mirroring on and a token, GET /metrics/federate… Reference for the PUT /api/v1/settings/monitoring/mirror endpoint in the TimescaleDB Enterprise API. - [Make a new mirroring token](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/rotate-metrics-mirror-token): Makes a random token and returns it once. The… Reference for the POST /api/v1/settings/monitoring/mirror/token endpoint in the TimescaleDB Enterprise API. - [Set metrics retention](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/set-metrics-retention): Saves the retention and restarts the metrics engine… Reference for the PUT /api/v1/settings/monitoring/retention endpoint in the TimescaleDB Enterprise API. - [Get single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/get-oidc-settings): The response never holds the client secret: client_secret_set tells… Reference for the GET /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Set single sign-on settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/update-oidc-settings): Applies at once, with no restart. When a save turns SSO on or changes… Reference for the PUT /api/v1/settings/oidc endpoint in the TimescaleDB Enterprise API. - [Test the OIDC issuer URL](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/test-oidc-settings): Reads the discovery document of the issuer. Saves nothing. ok… Reference for the POST /api/v1/settings/oidc/test endpoint in the TimescaleDB Enterprise API. - [Get the update check](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/get-update-check-settings): Get the update check setting. Reference for the GET /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. - [Set the update check](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/settings/set-update-check-settings): Off, the console does not read latest.json of the docs site… Reference for the PUT /api/v1/settings/update-check endpoint in the TimescaleDB Enterprise API. #### console-backup - [List backup archives](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/list-console-backup-archives): Reads the sidecars of each target, so the list also shows… Reference for the GET /api/v1/console-backup/archives endpoint in the TimescaleDB Enterprise API. - [Back up the console now](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/start-console-backup): Starts one backup of the console to the target, with the… Reference for the POST /api/v1/console-backup/backups endpoint in the TimescaleDB Enterprise API. - [Get the recovery key](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/get-console-backup-keys): Get the recovery key of the console backups. Reference for the GET /api/v1/console-backup/keys endpoint in the TimescaleDB Enterprise API. - [Confirm a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/confirm-console-backup-key): The admin confirms that they saved the key file that… Reference for the POST /api/v1/console-backup/keys/confirm endpoint in the TimescaleDB Enterprise API. - [Drop the unconfirmed key](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/drop-console-backup-pending-key): Drop the recovery key that waits for its confirm. Reference for the DELETE /api/v1/console-backup/keys/pending endpoint in the TimescaleDB Enterprise API. - [Make a new recovery key](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/rotate-console-backup-key): Makes a new age key pair and returns the private key… Reference for the POST /api/v1/console-backup/keys/rotate endpoint in the TimescaleDB Enterprise API. - [Make the first recovery key](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/setup-console-backup-key): Makes an age key pair and returns the private key once,… Reference for the POST /api/v1/console-backup/keys/setup endpoint in the TimescaleDB Enterprise API. - [Get the restore state](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/get-console-restore): The restore that runs now, and the latest restore of this… Reference for the GET /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Start a console restore](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/start-console-restore): Checks the archive as the check does, and needs the name of… Reference for the POST /api/v1/console-backup/restore endpoint in the TimescaleDB Enterprise API. - [Check a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/check-console-restore): Decrypts the archive with the recovery key, checks… Reference for the POST /api/v1/console-backup/restore/check endpoint in the TimescaleDB Enterprise API. - [Dismiss the restore banner](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/dismiss-console-restore): Dismiss the banner of the latest restore. Reference for the POST /api/v1/console-backup/restore/dismiss endpoint in the TimescaleDB Enterprise API. - [Upload a restore archive](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/upload-console-restore-archive): Streams the request body into the data volume. It… Reference for the POST /api/v1/console-backup/restore/uploads endpoint in the TimescaleDB Enterprise API. - [List console restores](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/list-console-restores): Each restore that a start applied, and each swap that… Reference for the GET /api/v1/console-backup/restores endpoint in the TimescaleDB Enterprise API. - [List backup runs](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/list-console-backup-runs): List the runs of the console backups, the newest first. Reference for the GET /api/v1/console-backup/runs endpoint in the TimescaleDB Enterprise API. - [Get a backup run](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/get-console-backup-run): Get a run of the console backups. Reference for the GET /api/v1/console-backup/runs/{id} endpoint in the TimescaleDB Enterprise API. - [List backup schedules](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/list-console-backup-schedules): Each schedule has its next three runs in UTC. The first… Reference for the GET /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Add a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/create-console-backup-schedule): Refuses a cron expression that does not parse, a… Reference for the POST /api/v1/console-backup/schedules endpoint in the TimescaleDB Enterprise API. - [Preview a cron schedule](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/get-console-backup-schedule-next-runs): Checks a cron expression as a create does, and… Reference for the GET /api/v1/console-backup/schedules/next-runs endpoint in the TimescaleDB Enterprise API. - [Remove a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/delete-console-backup-schedule): The runs and the archives of the schedule stay. A… Reference for the DELETE /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup schedule](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/update-console-backup-schedule): Replaces the cron expression, the target, the tiers… Reference for the PUT /api/v1/console-backup/schedules/{id} endpoint in the TimescaleDB Enterprise API. - [Get backup settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/get-console-backup-settings): Get the settings of the console backups. Reference for the GET /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Change backup settings](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/update-console-backup-settings): Turns "Back up after changes" on or off. Off: a change… Reference for the PUT /api/v1/console-backup/settings endpoint in the TimescaleDB Enterprise API. - [Estimate the backup size](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/get-console-backup-size-estimate): Gives the size of each tier before the compression,… Reference for the GET /api/v1/console-backup/size-estimate endpoint in the TimescaleDB Enterprise API. - [List backup targets](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/list-console-backup-targets): List the targets of the console backups. Reference for the GET /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Add a backup target](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/create-console-backup-target): Opens the target and writes the marker .tse-backup-target… Reference for the POST /api/v1/console-backup/targets endpoint in the TimescaleDB Enterprise API. - [Remove a backup target](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/delete-console-backup-target): The archives in the target stay. Refused while a… Reference for the DELETE /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Change a backup target](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/update-console-backup-target): Changes the name, and the settings or the credentials… Reference for the PUT /api/v1/console-backup/targets/{id} endpoint in the TimescaleDB Enterprise API. - [Delete a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/delete-console-backup-archive): Deletes the archive and its sidecar.… Reference for the DELETE /api/v1/console-backup/targets/{id}/archives/{name} endpoint in the TimescaleDB Enterprise API. - [Check a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/check-console-backup-archive): Reads the archive back from the… Reference for the POST /api/v1/console-backup/targets/{id}/archives/{name}/check endpoint in the TimescaleDB Enterprise API. - [Download a backup archive](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/download-console-backup-archive): Streams the encrypted archive… Reference for the GET /api/v1/console-backup/targets/{id}/archives/{name}/download endpoint in the TimescaleDB Enterprise API. - [Test a backup target](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/console-backup/test-console-backup-target): Checks the marker of the target, then writes,… Reference for the POST /api/v1/console-backup/targets/{id}/test endpoint in the TimescaleDB Enterprise API. #### metrics - [Get service metrics windows](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/metrics/get-database-service-metrics): Get service metrics windows. Reference for the GET /api/v1/database-services/{id}/metrics endpoint in the TimescaleDB Enterprise API. - [Run a PromQL instant query](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/metrics/promql-query): Execute PromQL instant query. Reference for the POST /api/v1/promql/query endpoint in the TimescaleDB Enterprise API. - [Run a PromQL range query](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/metrics/promql-query-range): Execute PromQL range query. Reference for the POST /api/v1/promql/query_range endpoint in the TimescaleDB Enterprise API. #### license - [Get current license status](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/get-license): Returns the installed licenses, the license consumption, whether the… Reference for the GET /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Upload license files](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/upload-licenses): Upload one or more license files. Reference for the POST /api/v1/license endpoint in the TimescaleDB Enterprise API. - [Activate a license online](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/activate-license): Activate a license online by key. Reference for the POST /api/v1/license/activate endpoint in the TimescaleDB Enterprise API. - [Check which licenses fit](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/license-fit): Check which installed licenses fit a proposed service topology. Reference for the POST /api/v1/license/fit endpoint in the TimescaleDB Enterprise API. - [Paste a license file](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/add-license-key): Add a license by pasting its file contents. Reference for the POST /api/v1/license/key endpoint in the TimescaleDB Enterprise API. - [Request a trial](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/start-trial): Request a trial and send a code to the email. Reference for the POST /api/v1/license/trial endpoint in the TimescaleDB Enterprise API. - [Start a trial with a code](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/verify-trial): Start a trial with the code from the email. Reference for the POST /api/v1/license/trial/verify endpoint in the TimescaleDB Enterprise API. - [Check installed licenses](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/verify-licenses): Re-check installed licenses with the licensing service. Reference for the POST /api/v1/license/verify endpoint in the TimescaleDB Enterprise API. - [Delete an unused license](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/delete-license): Delete an unused license. Reference for the DELETE /api/v1/license/{file} endpoint in the TimescaleDB Enterprise API. - [Get a license binding](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/get-license-bind): Read whether an air-gapped license is bound to this console. Reference for the GET /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Bind an air-gapped license](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/set-license-bind): Bind an air-gapped license to this console install. Reference for the POST /api/v1/license/{file}/bind endpoint in the TimescaleDB Enterprise API. - [Reset an expired trial](https://enterprise.tigerdata.com/docs/v2026.11.5-beta/reference/license/reset-trial): Reset an expired trial for another term. Reference for the POST /api/v1/license/{file}/reset-trial endpoint in the TimescaleDB Enterprise API. ## RSS Feeds - [TimescaleDB Enterprise — Changelog](https://enterprise.tigerdata.com/docs/changelog/rss.xml) ## Agent skills - [timescaledb-enterprise](https://enterprise.tigerdata.com/docs/.well-known/agent-skills/timescaledb-enterprise/SKILL.md): Read the TimescaleDB Enterprise docs instead of answering from memory. Deploy and manage PostgreSQL and TimescaleDB on your own servers, with high availability, backups, monitoring and air-gapped installs. Use when a task involves TimescaleDB Enterprise: how it works, how to set it up or configure it, or its API. ## Agent resources - [llms-full.txt](https://enterprise.tigerdata.com/docs/llms-full.txt): The full Markdown of every page in one file. - [Page Markdown](https://enterprise.tigerdata.com/docs/index.md): Append `.md` to any page URL to fetch that page as raw Markdown. - [JSON API](https://enterprise.tigerdata.com/docs/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://enterprise.tigerdata.com/docs/openapi.json. - [Agent skills](https://enterprise.tigerdata.com/docs/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes. - [API catalog](https://enterprise.tigerdata.com/docs/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here. - [AI catalog](https://enterprise.tigerdata.com/docs/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs). - [agent-readability.json](https://enterprise.tigerdata.com/docs/agent-readability.json): Manifest of every agent-facing artifact on this site. - [Sitemap](https://enterprise.tigerdata.com/docs/sitemap.xml): Every indexable page URL with its last-modified date.