---
seo:
  description: >-
    Management API for the TimescaleDB Enterprise Console: it registers
    bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL +
    TimescaleDB database…
  noindex: true
sidebar:
  label: Overview
title: TimescaleDB Enterprise API
---
Management API for the TimescaleDB Enterprise Console: it registers
bare-metal/VM servers into the WireGuard mesh, deploys PostgreSQL + TimescaleDB
database services onto them via Ansible, and manages backups, restores, and
health monitoring.

## Authentication

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

## Try requests

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

## Roles

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

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

## Errors

Errors are JSON with a stable shape:

    &#123;"error": "human-readable message", "details": ["optional", "specifics"]&#125;

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

## Asynchronous operations

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

## Spec

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

Version dev

Base URL: `https://console.example.com`

## system

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

- [`GET /api/v1/console/clock`](/docs/v2026.11.6-beta/reference/system/get-console-clock) — Get the console clock.
- [`GET /api/v1/console/time-sync`](/docs/v2026.11.6-beta/reference/system/get-time-sync) — Get the time sync state.
- [`GET /api/v1/info`](/docs/v2026.11.6-beta/reference/system/get-info) — Get console feature flags.
- [`GET /api/v1/mesh/status`](/docs/v2026.11.6-beta/reference/system/get-mesh-status) — Get the mesh status.
- [`GET /api/v1/packs`](/docs/v2026.11.6-beta/reference/system/list-packs) — List loaded packages.
- [`GET /api/v1/packs/available`](/docs/v2026.11.6-beta/reference/system/list-available-packs) — List release packages.
- [`GET /api/v1/packs/available/{name}/summary`](/docs/v2026.11.6-beta/reference/system/get-available-pack-summary) — Preview server packages.
- [`POST /api/v1/packs/download`](/docs/v2026.11.6-beta/reference/system/download-packs) — Download server packages.
- [`POST /api/v1/packs/remove-unused`](/docs/v2026.11.6-beta/reference/system/remove-unused-packs) — Remove unused packages.
- [`POST /api/v1/packs/rescan`](/docs/v2026.11.6-beta/reference/system/rescan-packs) — Verify server packages.
- [`POST /api/v1/packs/upload`](/docs/v2026.11.6-beta/reference/system/upload-pack) — Upload server packages.
- [`DELETE /api/v1/packs/{name}`](/docs/v2026.11.6-beta/reference/system/remove-pack) — Remove server packages.
- [`GET /api/v1/packs/{name}/summary`](/docs/v2026.11.6-beta/reference/system/get-pack-summary) — Show package contents.
- [`GET /api/v1/server-components`](/docs/v2026.11.6-beta/reference/system/list-server-components) — List server components.
- [`GET /api/v1/version`](/docs/v2026.11.6-beta/reference/system/get-version) — Get build version.
- [`POST /api/v1/version/check`](/docs/v2026.11.6-beta/reference/system/check-for-update) — Check for a newer release.

## auth

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

- [`GET /api/v1/auth/check`](/docs/v2026.11.6-beta/reference/auth/auth-check) — Check the session.
- [`GET /api/v1/auth/me`](/docs/v2026.11.6-beta/reference/auth/get-auth-me) — Get your session identity.
- [`GET /api/v1/auth/methods`](/docs/v2026.11.6-beta/reference/auth/get-auth-methods) — List login methods.
- [`POST /api/v1/auth/password`](/docs/v2026.11.6-beta/reference/auth/change-own-password) — Change your password.
- [`GET /api/v1/auth/two-factor`](/docs/v2026.11.6-beta/reference/auth/get-own-two-factor) — Get your two-factor state.
- [`POST /api/v1/auth/two-factor/disable`](/docs/v2026.11.6-beta/reference/auth/disable-own-two-factor) — Turn off your two-factor.
- [`POST /api/v1/auth/two-factor/enrolment`](/docs/v2026.11.6-beta/reference/auth/start-two-factor-enrolment) — Start TOTP enrolment.
- [`POST /api/v1/auth/two-factor/enrolment/confirm`](/docs/v2026.11.6-beta/reference/auth/confirm-two-factor-enrolment) — Confirm TOTP enrolment.
- [`POST /api/v1/auth/two-factor/recovery-codes`](/docs/v2026.11.6-beta/reference/auth/regenerate-recovery-codes) — Replace your recovery codes.
- [`POST /api/v1/auth/two-factor/verify`](/docs/v2026.11.6-beta/reference/auth/verify-second-factor) — Give the second factor.
- [`POST /api/v1/login`](/docs/v2026.11.6-beta/reference/auth/login) — Log in with the auth token.
- [`POST /api/v1/login/password`](/docs/v2026.11.6-beta/reference/auth/login-password) — Log in as a local user.
- [`POST /api/v1/logout`](/docs/v2026.11.6-beta/reference/auth/logout) — Log out.

## servers

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

- [`GET /api/v1/enroll/{token}`](/docs/v2026.11.6-beta/reference/servers/get-enroll-script) — Get the enrollment script.
- [`GET /api/v1/enroll/{token}/tailscale/{arch}/{binary}`](/docs/v2026.11.6-beta/reference/servers/get-enroll-agent) — Download the mesh agent.
- [`GET /api/v1/servers`](/docs/v2026.11.6-beta/reference/servers/list-servers) — List servers.
- [`POST /api/v1/servers`](/docs/v2026.11.6-beta/reference/servers/create-server) — Register a server.
- [`GET /api/v1/servers/demo-capacity`](/docs/v2026.11.6-beta/reference/servers/get-demo-capacity) — Get demo server capacity.
- [`GET /api/v1/servers/free`](/docs/v2026.11.6-beta/reference/servers/list-free-servers) — List free servers.
- [`DELETE /api/v1/servers/{id}`](/docs/v2026.11.6-beta/reference/servers/delete-server) — Delete a server.
- [`PATCH /api/v1/servers/{id}`](/docs/v2026.11.6-beta/reference/servers/update-server) — Rename a server.
- [`POST /api/v1/servers/{id}/backup`](/docs/v2026.11.6-beta/reference/servers/trigger-server-backup) — Trigger a server backup.
- [`GET /api/v1/servers/{id}/backup-state`](/docs/v2026.11.6-beta/reference/servers/get-server-backup-state) — Get on-disk backup state.
- [`GET /api/v1/servers/{id}/backups`](/docs/v2026.11.6-beta/reference/servers/list-server-backups) — List backups on a server.
- [`GET /api/v1/servers/{id}/demo-console`](/docs/v2026.11.6-beta/reference/servers/get-demo-server-console) — Stream a demo console.
- [`POST /api/v1/servers/{id}/enroll-command`](/docs/v2026.11.6-beta/reference/servers/regenerate-enroll-command) — Make a new enroll command.
- [`POST /api/v1/servers/{id}/retry-cleanup`](/docs/v2026.11.6-beta/reference/servers/retry-server-cleanup) — Retry a server cleanup.
- [`GET /api/v1/servers/{id}/specs`](/docs/v2026.11.6-beta/reference/servers/get-server-specs) — Get server hardware specs.
- [`POST /api/v1/servers/{id}/specs`](/docs/v2026.11.6-beta/reference/servers/refresh-server-specs) — Probe server hardware specs.
- [`GET /api/v1/servers/{id}/stanzas`](/docs/v2026.11.6-beta/reference/servers/list-server-stanzas) — List stanzas on a server.
- [`POST /api/v1/servers/{id}/test-ssh`](/docs/v2026.11.6-beta/reference/servers/test-ssh) — Test SSH to a server.

## stanzas

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

- [`POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/adopt`](/docs/v2026.11.6-beta/reference/stanzas/adopt-stanza) — Adopt an untracked stanza.
- [`POST /api/v1/servers/{serverId}/stanzas/{stanzaName}/delete`](/docs/v2026.11.6-beta/reference/stanzas/delete-untracked-stanza) — Delete an untracked stanza.
- [`GET /api/v1/stanzas/by-name/{name}`](/docs/v2026.11.6-beta/reference/stanzas/get-stanza-by-name) — Get a stanza by name.
- [`GET /api/v1/stanzas/orphaned`](/docs/v2026.11.6-beta/reference/stanzas/list-orphaned-stanzas) — List orphaned stanzas.
- [`POST /api/v1/stanzas/{stanzaId}/repos/{repoId}/delete`](/docs/v2026.11.6-beta/reference/stanzas/delete-stanza-repo) — Delete a stanza's repo data.

## database-services

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

- [`GET /api/v1/database-services`](/docs/v2026.11.6-beta/reference/database-services/list-database-services) — List database services.
- [`POST /api/v1/database-services`](/docs/v2026.11.6-beta/reference/database-services/create-database-service) — Create a database service.
- [`POST /api/v1/database-services/preflight`](/docs/v2026.11.6-beta/reference/database-services/preflight-database-service-plan) — Run pre-create checks.
- [`DELETE /api/v1/database-services/{id}`](/docs/v2026.11.6-beta/reference/database-services/delete-database-service) — Delete a database service.
- [`GET /api/v1/database-services/{id}`](/docs/v2026.11.6-beta/reference/database-services/get-database-service) — Get a database service.
- [`PATCH /api/v1/database-services/{id}`](/docs/v2026.11.6-beta/reference/database-services/update-database-service) — Update a database service.
- [`GET /api/v1/database-services/{id}/access`](/docs/v2026.11.6-beta/reference/database-services/list-database-service-access) — List users with access.
- [`POST /api/v1/database-services/{id}/apply-backup-config`](/docs/v2026.11.6-beta/reference/database-services/apply-database-service-backup-config) — Apply the backup config.
- [`POST /api/v1/database-services/{id}/apply-exporters-config`](/docs/v2026.11.6-beta/reference/database-services/apply-database-service-exporters-config) — Apply the exporters config.
- [`POST /api/v1/database-services/{id}/apply-license-caps`](/docs/v2026.11.6-beta/reference/database-services/apply-database-service-license-caps) — Apply the license caps.
- [`POST /api/v1/database-services/{id}/backup`](/docs/v2026.11.6-beta/reference/database-services/trigger-database-service-backup) — Trigger a pgbackrest backup.
- [`GET /api/v1/database-services/{id}/config-files`](/docs/v2026.11.6-beta/reference/database-services/list-database-service-config-files) — List config files.
- [`POST /api/v1/database-services/{id}/config-files/check`](/docs/v2026.11.6-beta/reference/database-services/check-database-service-config-drift) — Check config file drift.
- [`GET /api/v1/database-services/{id}/config-files/{snapshot}`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-config-file-version) — Get a config file version.
- [`POST /api/v1/database-services/{id}/debug-bundle`](/docs/v2026.11.6-beta/reference/database-services/create-database-service-debug-bundle) — Write a debug bundle.
- [`POST /api/v1/database-services/{id}/deploy`](/docs/v2026.11.6-beta/reference/database-services/deploy-database-service) — Deploy a database service.
- [`DELETE /api/v1/database-services/{id}/emergency-space`](/docs/v2026.11.6-beta/reference/database-services/finish-database-service-emergency-space) — Return to read-write.
- [`GET /api/v1/database-services/{id}/emergency-space`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-emergency-space) — Get emergency space state.
- [`POST /api/v1/database-services/{id}/emergency-space`](/docs/v2026.11.6-beta/reference/database-services/start-database-service-emergency-space) — Free emergency space.
- [`POST /api/v1/database-services/{id}/emergency-space/recreate`](/docs/v2026.11.6-beta/reference/database-services/recreate-database-service-emergency-space) — Recreate balloon files.
- [`POST /api/v1/database-services/{id}/extensions/create`](/docs/v2026.11.6-beta/reference/database-services/create-database-service-extensions) — Create loaded extensions.
- [`GET /api/v1/database-services/{id}/extensions/live`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-live-extensions) — List live extensions.
- [`POST /api/v1/database-services/{id}/extensions/restart`](/docs/v2026.11.6-beta/reference/database-services/restart-database-service-extensions) — Restart for new extensions.
- [`GET /api/v1/database-services/{id}/extensions/{name}/dependents`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-extension-dependents) — List extension dependents.
- [`POST /api/v1/database-services/{id}/extensions/{name}/drop`](/docs/v2026.11.6-beta/reference/database-services/drop-database-service-extension) — Drop an extension.
- [`GET /api/v1/database-services/{id}/grant`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-grant) — Get the license grant.
- [`POST /api/v1/database-services/{id}/grant`](/docs/v2026.11.6-beta/reference/database-services/set-database-service-grant) — Set the license grant.
- [`GET /api/v1/database-services/{id}/health`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-health) — Get service health.
- [`GET /api/v1/database-services/{id}/health/etcd`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-etcd-health) — Get etcd health.
- [`GET /api/v1/database-services/{id}/health/haproxy`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-haproxy-health) — Get HAProxy health.
- [`GET /api/v1/database-services/{id}/health/patroni`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-patroni-health) — Get Patroni health.
- [`GET /api/v1/database-services/{id}/health/pgbackrest`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-pgbackrest-health) — Get pgBackRest health.
- [`GET /api/v1/database-services/{id}/health/pgbouncer`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-pgbouncer-health) — Get PgBouncer health.
- [`GET /api/v1/database-services/{id}/health/reserve`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-reserve-health) — Get balloon file health.
- [`GET /api/v1/database-services/{id}/info/postgresql`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-postgresql-info) — Get PostgreSQL info.
- [`GET /api/v1/database-services/{id}/info/versions`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-versions) — Get observed versions.
- [`POST /api/v1/database-services/{id}/lan-address-changes/dismiss`](/docs/v2026.11.6-beta/reference/database-services/dismiss-database-service-lan-address-changes) — Dismiss LAN address changes.
- [`POST /api/v1/database-services/{id}/license`](/docs/v2026.11.6-beta/reference/database-services/set-database-service-license) — Change a service's license.
- [`GET /api/v1/database-services/{id}/logs`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-logs) — Stream the workflow log.
- [`GET /api/v1/database-services/{id}/major-upgrade`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-major-upgrade) — Get the major upgrade.
- [`POST /api/v1/database-services/{id}/major-upgrade`](/docs/v2026.11.6-beta/reference/database-services/upgrade-database-service-major) — Run a major upgrade.
- [`POST /api/v1/database-services/{id}/major-upgrade/check`](/docs/v2026.11.6-beta/reference/database-services/check-database-service-major-upgrade) — Check a major upgrade.
- [`POST /api/v1/database-services/{id}/major-upgrade/cleanup`](/docs/v2026.11.6-beta/reference/database-services/cleanup-database-service-major-upgrade) — Clean up a major upgrade.
- [`POST /api/v1/database-services/{id}/major-upgrade/grant`](/docs/v2026.11.6-beta/reference/database-services/paste-database-service-major-upgrade-grant) — Give a major upgrade grant.
- [`POST /api/v1/database-services/{id}/major-upgrade/rollback`](/docs/v2026.11.6-beta/reference/database-services/rollback-database-service-major-upgrade) — Roll back a major upgrade.
- [`POST /api/v1/database-services/{id}/major-upgrade/stanza`](/docs/v2026.11.6-beta/reference/database-services/stanza-database-service-major-upgrade) — Upgrade the backup stanza.
- [`POST /api/v1/database-services/{id}/patroni/failover`](/docs/v2026.11.6-beta/reference/database-services/database-service-patroni-failover) — Fail over to a node.
- [`POST /api/v1/database-services/{id}/patroni/restart`](/docs/v2026.11.6-beta/reference/database-services/database-service-patroni-restart) — Restart Patroni on a node.
- [`POST /api/v1/database-services/{id}/patroni/rolling-restart`](/docs/v2026.11.6-beta/reference/database-services/database-service-patroni-rolling-restart) — Rolling-restart the cluster.
- [`POST /api/v1/database-services/{id}/patroni/switchover`](/docs/v2026.11.6-beta/reference/database-services/database-service-patroni-switchover) — Switch over to a node.
- [`POST /api/v1/database-services/{id}/preflight`](/docs/v2026.11.6-beta/reference/database-services/preflight-database-service) — Run pre-deploy checks.
- [`POST /api/v1/database-services/{id}/remove`](/docs/v2026.11.6-beta/reference/database-services/remove-database-service) — Remove a database service.
- [`POST /api/v1/database-services/{id}/restore`](/docs/v2026.11.6-beta/reference/database-services/restore-database-service) — Restore a database service.
- [`GET /api/v1/database-services/{id}/servers/{serverId}/logs`](/docs/v2026.11.6-beta/reference/database-services/get-server-logs) — Fetch logs from a server.
- [`POST /api/v1/database-services/{id}/servers/{server_id}/rebuild`](/docs/v2026.11.6-beta/reference/database-services/rebuild-database-service-server) — Rebuild a replaced member.
- [`POST /api/v1/database-services/{id}/servers/{server_id}/rebuild-replica`](/docs/v2026.11.6-beta/reference/database-services/rebuild-database-service-replica) — Rebuild a replica.
- [`GET /api/v1/database-services/{id}/settings`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-settings) — Get live settings.
- [`POST /api/v1/database-services/{id}/settings/apply`](/docs/v2026.11.6-beta/reference/database-services/apply-database-service-settings) — Apply settings changes.
- [`POST /api/v1/database-services/{id}/settings/discard`](/docs/v2026.11.6-beta/reference/database-services/discard-database-service-settings) — Discard pending settings.
- [`POST /api/v1/database-services/{id}/settings/plan`](/docs/v2026.11.6-beta/reference/database-services/plan-database-service-settings) — Review settings changes.
- [`POST /api/v1/database-services/{id}/settings/restart`](/docs/v2026.11.6-beta/reference/database-services/restart-database-service-settings) — Restart for new settings.
- [`GET /api/v1/database-services/{id}/settings/yaml`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-settings-yaml) — Get overrides as YAML.
- [`POST /api/v1/database-services/{id}/slots/{member_name}/fill`](/docs/v2026.11.6-beta/reference/database-services/fill-database-service-slot) — Fill a member slot.
- [`POST /api/v1/database-services/{id}/slots/{member_name}/release`](/docs/v2026.11.6-beta/reference/database-services/release-database-service-slot) — Release a member slot.
- [`POST /api/v1/database-services/{id}/sql/api/arrowResults`](/docs/v2026.11.6-beta/reference/database-services/database-service-sql-arrow-results) — Fetch query rows as Arrow.
- [`POST /api/v1/database-services/{id}/sql/api/executeQuery`](/docs/v2026.11.6-beta/reference/database-services/database-service-sql-execute-query) — Run a SQL query.
- [`GET /api/v1/database-services/{id}/sql/api/schema`](/docs/v2026.11.6-beta/reference/database-services/database-service-sql-schema) — Fetch the database schema.
- [`POST /api/v1/database-services/{id}/sql/ro/api/arrowResults`](/docs/v2026.11.6-beta/reference/database-services/database-service-sql-arrow-results-readonly) — Fetch read-only Arrow rows.
- [`POST /api/v1/database-services/{id}/sql/ro/api/executeQuery`](/docs/v2026.11.6-beta/reference/database-services/database-service-sql-execute-query-readonly) — Run a read-only SQL query.
- [`GET /api/v1/database-services/{id}/upgrade`](/docs/v2026.11.6-beta/reference/database-services/get-database-service-upgrade) — Get the available upgrade.
- [`POST /api/v1/database-services/{id}/upgrade`](/docs/v2026.11.6-beta/reference/database-services/upgrade-database-service) — Upgrade a database service.
- [`POST /api/v1/database-services/{id}/upgrade/check`](/docs/v2026.11.6-beta/reference/database-services/check-database-service-upgrade) — Check a service upgrade.
- [`POST /api/v1/database-services/{id}/vip`](/docs/v2026.11.6-beta/reference/database-services/change-database-service-vip) — Change the virtual IP.
- [`GET /api/v1/extensions`](/docs/v2026.11.6-beta/reference/database-services/list-extensions) — List available extensions.

## dcs-clusters

Standalone etcd (DCS) clusters backing advanced HA topologies.

- [`GET /api/v1/dcs-clusters`](/docs/v2026.11.6-beta/reference/dcs-clusters/list-dcs-clusters) — List DCS clusters.
- [`POST /api/v1/dcs-clusters`](/docs/v2026.11.6-beta/reference/dcs-clusters/create-dcs-cluster) — Create a DCS cluster.
- [`POST /api/v1/dcs-clusters/preflight`](/docs/v2026.11.6-beta/reference/dcs-clusters/preflight-dcs-cluster) — Run DCS pre-deploy checks.
- [`DELETE /api/v1/dcs-clusters/{id}`](/docs/v2026.11.6-beta/reference/dcs-clusters/delete-dcs-cluster) — Delete a DCS cluster.
- [`GET /api/v1/dcs-clusters/{id}`](/docs/v2026.11.6-beta/reference/dcs-clusters/get-dcs-cluster) — Get a DCS cluster.
- [`GET /api/v1/dcs-clusters/{id}/health`](/docs/v2026.11.6-beta/reference/dcs-clusters/get-dcs-cluster-health) — Get DCS cluster health.
- [`POST /api/v1/dcs-clusters/{id}/redeploy`](/docs/v2026.11.6-beta/reference/dcs-clusters/redeploy-dcs-cluster) — Redeploy a DCS cluster.
- [`POST /api/v1/dcs-clusters/{id}/servers/{server_id}/rebuild`](/docs/v2026.11.6-beta/reference/dcs-clusters/rebuild-dcs-cluster-server) — Rebuild a DCS member.
- [`POST /api/v1/dcs-clusters/{id}/slots/{member_name}/fill`](/docs/v2026.11.6-beta/reference/dcs-clusters/fill-dcs-cluster-slot) — Fill a DCS member slot.
- [`POST /api/v1/dcs-clusters/{id}/slots/{member_name}/release`](/docs/v2026.11.6-beta/reference/dcs-clusters/release-dcs-cluster-slot) — Release a DCS member slot.

## livesync

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

- [`GET /api/v1/livesync`](/docs/v2026.11.6-beta/reference/livesync/list-livesyncs) — List livesync sessions.
- [`POST /api/v1/livesync`](/docs/v2026.11.6-beta/reference/livesync/create-livesync) — Create a livesync session.
- [`GET /api/v1/livesync/source-preflight`](/docs/v2026.11.6-beta/reference/livesync/livesync-source-preflight) — Check a source's wal\_level.
- [`GET /api/v1/livesync/source-tables`](/docs/v2026.11.6-beta/reference/livesync/livesync-source-tables) — List source tables.
- [`POST /api/v1/livesync/source/{id}/enable-logical`](/docs/v2026.11.6-beta/reference/livesync/livesync-enable-logical) — Set wal\_level to logical.
- [`DELETE /api/v1/livesync/{id}`](/docs/v2026.11.6-beta/reference/livesync/delete-livesync) — Remove a livesync session.
- [`GET /api/v1/livesync/{id}`](/docs/v2026.11.6-beta/reference/livesync/get-livesync) — Get a livesync session.
- [`PATCH /api/v1/livesync/{id}`](/docs/v2026.11.6-beta/reference/livesync/update-livesync) — Change livesync options.
- [`GET /api/v1/livesync/{id}/health`](/docs/v2026.11.6-beta/reference/livesync/livesync-health) — Get livesync health.
- [`POST /api/v1/livesync/{id}/start`](/docs/v2026.11.6-beta/reference/livesync/start-livesync) — Start a livesync session.
- [`POST /api/v1/livesync/{id}/stop`](/docs/v2026.11.6-beta/reference/livesync/stop-livesync) — Stop a livesync session.
- [`GET /api/v1/livesync/{id}/tables`](/docs/v2026.11.6-beta/reference/livesync/livesync-tables) — List a session's tables.
- [`POST /api/v1/livesync/{id}/tables`](/docs/v2026.11.6-beta/reference/livesync/publish-livesync-tables) — Change a session's tables.

## workflows

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

- [`GET /api/v1/workflows`](/docs/v2026.11.6-beta/reference/workflows/list-workflows) — List workflows.
- [`DELETE /api/v1/workflows/{id}`](/docs/v2026.11.6-beta/reference/workflows/delete-workflow) — Delete a workflow.
- [`GET /api/v1/workflows/{id}`](/docs/v2026.11.6-beta/reference/workflows/get-workflow) — Get a workflow.
- [`GET /api/v1/workflows/{id}/inventory`](/docs/v2026.11.6-beta/reference/workflows/get-workflow-inventory) — Get a workflow's inventory.
- [`POST /api/v1/workflows/{id}/kill`](/docs/v2026.11.6-beta/reference/workflows/kill-workflow) — Kill a running workflow.
- [`GET /api/v1/workflows/{id}/stderr`](/docs/v2026.11.6-beta/reference/workflows/stream-workflow-stderr) — Stream a workflow's stderr.
- [`GET /api/v1/workflows/{id}/stdout`](/docs/v2026.11.6-beta/reference/workflows/stream-workflow-stdout) — Stream a workflow's stdout.

## reports

Support bundles: async collection, download, and lifecycle.

- [`GET /api/v1/reports`](/docs/v2026.11.6-beta/reference/reports/list-reports) — List support reports.
- [`POST /api/v1/reports`](/docs/v2026.11.6-beta/reference/reports/create-report) — Create a support report.
- [`DELETE /api/v1/reports/{id}`](/docs/v2026.11.6-beta/reference/reports/delete-report) — Delete a support report.
- [`GET /api/v1/reports/{id}`](/docs/v2026.11.6-beta/reference/reports/get-report) — Get a support report.
- [`GET /api/v1/reports/{id}/download`](/docs/v2026.11.6-beta/reference/reports/download-report) — Download a support report.

## alerts

Alert rule state, notification destinations, and configurable thresholds.

- [`GET /api/v1/alert-delivery`](/docs/v2026.11.6-beta/reference/alerts/get-alert-delivery) — Get alert destinations.
- [`PUT /api/v1/alert-delivery`](/docs/v2026.11.6-beta/reference/alerts/put-alert-delivery) — Set heartbeat destination.
- [`POST /api/v1/alert-delivery/destinations`](/docs/v2026.11.6-beta/reference/alerts/post-alert-destination) — Add an alert destination.
- [`DELETE /api/v1/alert-delivery/destinations/{id}`](/docs/v2026.11.6-beta/reference/alerts/delete-alert-destination) — Remove an alert destination.
- [`PATCH /api/v1/alert-delivery/destinations/{id}`](/docs/v2026.11.6-beta/reference/alerts/patch-alert-destination) — Change an alert destination.
- [`POST /api/v1/alert-delivery/destinations/{id}/test`](/docs/v2026.11.6-beta/reference/alerts/post-alert-destination-test) — Test an alert destination.
- [`GET /api/v1/alert-overrides`](/docs/v2026.11.6-beta/reference/alerts/list-alert-overrides) — List all alert overrides.
- [`PUT /api/v1/alert-planned-operations`](/docs/v2026.11.6-beta/reference/alerts/put-alert-planned-operations) — Set operation silences.
- [`GET /api/v1/alert-rules`](/docs/v2026.11.6-beta/reference/alerts/get-alert-rules) — Get global alert rules.
- [`PUT /api/v1/alert-rules`](/docs/v2026.11.6-beta/reference/alerts/put-alert-rules) — Change global alert rules.
- [`DELETE /api/v1/alert-smtp`](/docs/v2026.11.6-beta/reference/alerts/delete-alert-smtp) — Remove the SMTP settings.
- [`GET /api/v1/alert-smtp`](/docs/v2026.11.6-beta/reference/alerts/get-alert-smtp) — Get the SMTP settings.
- [`PUT /api/v1/alert-smtp`](/docs/v2026.11.6-beta/reference/alerts/put-alert-smtp) — Set the SMTP settings.
- [`GET /api/v1/alerts`](/docs/v2026.11.6-beta/reference/alerts/get-alerts) — Get alerts and their state.
- [`DELETE /api/v1/database-services/{id}/alert-mute`](/docs/v2026.11.6-beta/reference/alerts/delete-database-service-alert-mute) — Unmute a service's alerts.
- [`POST /api/v1/database-services/{id}/alert-mute`](/docs/v2026.11.6-beta/reference/alerts/post-database-service-alert-mute) — Mute a service's alerts.
- [`DELETE /api/v1/database-services/{id}/alert-overrides`](/docs/v2026.11.6-beta/reference/alerts/delete-database-service-alert-overrides) — Remove alert overrides.
- [`GET /api/v1/database-services/{id}/alert-overrides`](/docs/v2026.11.6-beta/reference/alerts/get-database-service-alert-overrides) — Get service alert overrides.
- [`PUT /api/v1/database-services/{id}/alert-overrides`](/docs/v2026.11.6-beta/reference/alerts/put-database-service-alert-overrides) — Set service alert overrides.
- [`GET /api/v1/database-services/{id}/alert-rules`](/docs/v2026.11.6-beta/reference/alerts/get-database-service-alert-rules) — Get a service's alert rules.

## users

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

- [`GET /api/v1/two-factor-policy`](/docs/v2026.11.6-beta/reference/users/get-two-factor-policy) — Get the two-factor policy.
- [`PUT /api/v1/two-factor-policy`](/docs/v2026.11.6-beta/reference/users/update-two-factor-policy) — Set the two-factor policy.
- [`GET /api/v1/users`](/docs/v2026.11.6-beta/reference/users/list-users) — List the users.
- [`POST /api/v1/users`](/docs/v2026.11.6-beta/reference/users/create-user) — Create a local user.
- [`DELETE /api/v1/users/{id}`](/docs/v2026.11.6-beta/reference/users/delete-user) — Delete a user.
- [`PATCH /api/v1/users/{id}`](/docs/v2026.11.6-beta/reference/users/update-user) — Change a user.
- [`POST /api/v1/users/{id}/password`](/docs/v2026.11.6-beta/reference/users/reset-user-password) — Reset a user's password.
- [`GET /api/v1/users/{id}/service-grants`](/docs/v2026.11.6-beta/reference/users/list-user-service-grants) — List a user's grants.
- [`DELETE /api/v1/users/{id}/service-grants/{service_id}`](/docs/v2026.11.6-beta/reference/users/delete-user-service-grant) — Remove a service grant.
- [`PUT /api/v1/users/{id}/service-grants/{service_id}`](/docs/v2026.11.6-beta/reference/users/set-user-service-grant) — Set a user's service role.
- [`DELETE /api/v1/users/{id}/two-factor`](/docs/v2026.11.6-beta/reference/users/reset-user-two-factor) — Reset a user's two-factor.

## audit

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

- [`GET /api/v1/audit-events`](/docs/v2026.11.6-beta/reference/audit/list-audit-events) — List the audit log.
- [`GET /api/v1/audit-events/export`](/docs/v2026.11.6-beta/reference/audit/export-audit-events) — Export the audit log.
- [`GET /api/v1/audit-events/{id}`](/docs/v2026.11.6-beta/reference/audit/get-audit-event) — Get an audit log row.

## settings

Console settings: single sign-on (OIDC).

- [`GET /api/v1/settings/deploy-logs`](/docs/v2026.11.6-beta/reference/settings/get-deploy-log-settings) — Get the deploy log setting.
- [`PUT /api/v1/settings/deploy-logs`](/docs/v2026.11.6-beta/reference/settings/set-deploy-log-settings) — Set verbose deploy logs.
- [`GET /api/v1/settings/monitoring`](/docs/v2026.11.6-beta/reference/settings/get-monitoring-settings) — Get monitoring settings.
- [`PUT /api/v1/settings/monitoring/mirror`](/docs/v2026.11.6-beta/reference/settings/set-metrics-mirroring) — Set metrics mirroring.
- [`POST /api/v1/settings/monitoring/mirror/token`](/docs/v2026.11.6-beta/reference/settings/rotate-metrics-mirror-token) — Make a new mirroring token.
- [`PUT /api/v1/settings/monitoring/retention`](/docs/v2026.11.6-beta/reference/settings/set-metrics-retention) — Set metrics retention.
- [`GET /api/v1/settings/oidc`](/docs/v2026.11.6-beta/reference/settings/get-oidc-settings) — Get single sign-on settings.
- [`PUT /api/v1/settings/oidc`](/docs/v2026.11.6-beta/reference/settings/update-oidc-settings) — Set single sign-on settings.
- [`POST /api/v1/settings/oidc/test`](/docs/v2026.11.6-beta/reference/settings/test-oidc-settings) — Test the OIDC issuer URL.
- [`GET /api/v1/settings/update-check`](/docs/v2026.11.6-beta/reference/settings/get-update-check-settings) — Get the update check.
- [`PUT /api/v1/settings/update-check`](/docs/v2026.11.6-beta/reference/settings/set-update-check-settings) — Set the update check.

## console-backup

- [`GET /api/v1/console-backup/archives`](/docs/v2026.11.6-beta/reference/console-backup/list-console-backup-archives) — List backup archives.
- [`POST /api/v1/console-backup/backups`](/docs/v2026.11.6-beta/reference/console-backup/start-console-backup) — Back up the console now.
- [`GET /api/v1/console-backup/keys`](/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-keys) — Get the recovery key.
- [`POST /api/v1/console-backup/keys/confirm`](/docs/v2026.11.6-beta/reference/console-backup/confirm-console-backup-key) — Confirm a new recovery key.
- [`DELETE /api/v1/console-backup/keys/pending`](/docs/v2026.11.6-beta/reference/console-backup/drop-console-backup-pending-key) — Drop the unconfirmed key.
- [`POST /api/v1/console-backup/keys/rotate`](/docs/v2026.11.6-beta/reference/console-backup/rotate-console-backup-key) — Make a new recovery key.
- [`POST /api/v1/console-backup/keys/setup`](/docs/v2026.11.6-beta/reference/console-backup/setup-console-backup-key) — Make the first recovery key.
- [`GET /api/v1/console-backup/restore`](/docs/v2026.11.6-beta/reference/console-backup/get-console-restore) — Get the restore state.
- [`POST /api/v1/console-backup/restore`](/docs/v2026.11.6-beta/reference/console-backup/start-console-restore) — Start a console restore.
- [`POST /api/v1/console-backup/restore/check`](/docs/v2026.11.6-beta/reference/console-backup/check-console-restore) — Check a restore archive.
- [`POST /api/v1/console-backup/restore/dismiss`](/docs/v2026.11.6-beta/reference/console-backup/dismiss-console-restore) — Dismiss the restore banner.
- [`POST /api/v1/console-backup/restore/uploads`](/docs/v2026.11.6-beta/reference/console-backup/upload-console-restore-archive) — Upload a restore archive.
- [`GET /api/v1/console-backup/restores`](/docs/v2026.11.6-beta/reference/console-backup/list-console-restores) — List console restores.
- [`GET /api/v1/console-backup/runs`](/docs/v2026.11.6-beta/reference/console-backup/list-console-backup-runs) — List backup runs.
- [`GET /api/v1/console-backup/runs/{id}`](/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-run) — Get a backup run.
- [`GET /api/v1/console-backup/schedules`](/docs/v2026.11.6-beta/reference/console-backup/list-console-backup-schedules) — List backup schedules.
- [`POST /api/v1/console-backup/schedules`](/docs/v2026.11.6-beta/reference/console-backup/create-console-backup-schedule) — Add a backup schedule.
- [`GET /api/v1/console-backup/schedules/next-runs`](/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-schedule-next-runs) — Preview a cron schedule.
- [`DELETE /api/v1/console-backup/schedules/{id}`](/docs/v2026.11.6-beta/reference/console-backup/delete-console-backup-schedule) — Remove a backup schedule.
- [`PUT /api/v1/console-backup/schedules/{id}`](/docs/v2026.11.6-beta/reference/console-backup/update-console-backup-schedule) — Change a backup schedule.
- [`GET /api/v1/console-backup/settings`](/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-settings) — Get backup settings.
- [`PUT /api/v1/console-backup/settings`](/docs/v2026.11.6-beta/reference/console-backup/update-console-backup-settings) — Change backup settings.
- [`GET /api/v1/console-backup/size-estimate`](/docs/v2026.11.6-beta/reference/console-backup/get-console-backup-size-estimate) — Estimate the backup size.
- [`GET /api/v1/console-backup/targets`](/docs/v2026.11.6-beta/reference/console-backup/list-console-backup-targets) — List backup targets.
- [`POST /api/v1/console-backup/targets`](/docs/v2026.11.6-beta/reference/console-backup/create-console-backup-target) — Add a backup target.
- [`DELETE /api/v1/console-backup/targets/{id}`](/docs/v2026.11.6-beta/reference/console-backup/delete-console-backup-target) — Remove a backup target.
- [`PUT /api/v1/console-backup/targets/{id}`](/docs/v2026.11.6-beta/reference/console-backup/update-console-backup-target) — Change a backup target.
- [`DELETE /api/v1/console-backup/targets/{id}/archives/{name}`](/docs/v2026.11.6-beta/reference/console-backup/delete-console-backup-archive) — Delete a backup archive.
- [`POST /api/v1/console-backup/targets/{id}/archives/{name}/check`](/docs/v2026.11.6-beta/reference/console-backup/check-console-backup-archive) — Check a backup archive.
- [`GET /api/v1/console-backup/targets/{id}/archives/{name}/download`](/docs/v2026.11.6-beta/reference/console-backup/download-console-backup-archive) — Download a backup archive.
- [`POST /api/v1/console-backup/targets/{id}/test`](/docs/v2026.11.6-beta/reference/console-backup/test-console-backup-target) — Test a backup target.

## metrics

- [`GET /api/v1/database-services/{id}/metrics`](/docs/v2026.11.6-beta/reference/metrics/get-database-service-metrics) — Get service metrics windows.
- [`POST /api/v1/promql/query`](/docs/v2026.11.6-beta/reference/metrics/promql-query) — Run a PromQL instant query.
- [`POST /api/v1/promql/query_range`](/docs/v2026.11.6-beta/reference/metrics/promql-query-range) — Run a PromQL range query.

## license

- [`GET /api/v1/license`](/docs/v2026.11.6-beta/reference/license/get-license) — Get current license status.
- [`POST /api/v1/license`](/docs/v2026.11.6-beta/reference/license/upload-licenses) — Upload license files.
- [`POST /api/v1/license/activate`](/docs/v2026.11.6-beta/reference/license/activate-license) — Activate a license online.
- [`POST /api/v1/license/fit`](/docs/v2026.11.6-beta/reference/license/license-fit) — Check which licenses fit.
- [`POST /api/v1/license/key`](/docs/v2026.11.6-beta/reference/license/add-license-key) — Paste a license file.
- [`POST /api/v1/license/trial`](/docs/v2026.11.6-beta/reference/license/start-trial) — Request a trial.
- [`POST /api/v1/license/trial/verify`](/docs/v2026.11.6-beta/reference/license/verify-trial) — Start a trial with a code.
- [`POST /api/v1/license/verify`](/docs/v2026.11.6-beta/reference/license/verify-licenses) — Check installed licenses.
- [`DELETE /api/v1/license/{file}`](/docs/v2026.11.6-beta/reference/license/delete-license) — Delete an unused license.
- [`GET /api/v1/license/{file}/bind`](/docs/v2026.11.6-beta/reference/license/get-license-bind) — Get a license binding.
- [`POST /api/v1/license/{file}/bind`](/docs/v2026.11.6-beta/reference/license/set-license-bind) — Bind an air-gapped license.
- [`POST /api/v1/license/{file}/reset-trial`](/docs/v2026.11.6-beta/reference/license/reset-trial) — Reset an expired trial.
