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

Check a service upgrade

Resolves the picked items, and checks the service, its databases and its servers with no downtime (ADR 2026-10-21 decision items 3 and 6). The servers download the target packages to resolve them. The workflow is upgrade_service_check; GET /database-services/{id}/upgrade gives its report. 409 when the service does not run or another action runs.

POST/api/v1/database-services/{id}/upgrade/check
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Request body
requiredapplication/json
itemsUpgradeRequest[]

The picked items. Empty: the default, every item at its newest version in the pinned release, and every console component at its newest version. A newer release is never a default.

Show properties
Array of UpgradeRequest
namestringrequired

postgresql, patroni, pgbouncer, haproxy, keepalived, the catalog name of an extension of the service (timescaledb, pgvector and so on), or a console component item: pgbackrest, tsdbe, etcd, confd, dcs_etcd, node_exporter, postgres_exporter, pgbouncer_exporter, sql_exporter, pg_auto_reindexer, tailscale, backup_server_tailscale, dcs_tailscale

targetstring

The version to move to. Empty: the newest version in the loaded server packages or server components. A component at the version that its servers have already is copied and restarted again.

Responses
202

Accepted

workflow_idstringrequired
default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X POST 'https://console.example.com/api/v1/database-services/string/upgrade/check' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "items": [
    {
      "name": "string",
      "target": "string"
    }
  ]
}'
Response
{
  "workflow_id": "string"
}