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 major upgrade

Checks the PostgreSQL major upgrade to one target with no downtime (ADR 2026-10-22 decision item 2): target is any major of the pinned release newer than the major of the service, the next major when it is absent (D9). minor is an eligible minor of the target (TSE-1116), the newest eligible minor when it is absent. Each server installs the packages of the target at that minor beside the current major from the pinned release, and holds them; the leader runs pg_upgrade –check against the running cluster. The console checks the backup gate (a full backup from the last 24 hours and healthy WAL archiving, with no override), Patroni, the DCS, the licence grant, LiveSync, tsdbe for the target, the extensions, the parameters and the disk, and estimates the maintenance window. The workflow is upgrade_major_check; GET /database-services/{id}/major-upgrade gives its report. 409 when the service does not run or another action runs. 422 when the minor is not eligible, the pinned release does not have it, or it comes with no target.

POST/api/v1/database-services/{id}/major-upgrade/check
Authorization
tse_sessionAPI key · cookierequired
Path parameters
idstringrequired
Request body
application/json
minorstring

The minor of the target to install, for example 18.4: an eligible minor of the target in the pinned release (TSE-1116, the minors of the target in GET). Needs target. Absent: the newest eligible minor.

matches ^[0-9]{2}[.][0-9]+$
targetstring

The major to check, for example 19: a major of the pinned release newer than the major of the service (ADR 2026-10-22 D9). Absent: the next major.

matches ^[0-9]{2}$
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/major-upgrade/check' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "minor": "string",
  "target": "string"
}'
Response
{
  "workflow_id": "string"
}