Get the available upgrade
The items that the loaded server packages can move: the PostgreSQL minor, each extension, Patroni and pgBouncer. The default selection has each item at the newest version of the pinned release, with the items that they need (ADR 2026-10-21 decisions 2 and 30). The options have every target, also from newer releases, each with what Check adds with it (TSE-1066). And the console components that the loaded server components can move: pgBackRest of the backup group, tsdbe, etcd, confd, the exporters, pg_auto_reindexer and Tailscale (decisions 29 to 34). And the report of the last Check.
/api/v1/database-services/{id}/upgradetse_sessionAPI key · cookierequiredidstringrequiredOK
availableUpgradePlanrequiredThe default selection: every item that the pinned server packages have at a newer version, at the newest version of the pinned release, with the items that it needs. A newer release is never a default (TSE-1066).
Show propertiesHide properties
blockersstring[]requireditemsUpgradeItem[]requiredShow propertiesHide properties
UpgradeItemaddedbooleanCheck added the item, because a picked item needs it
effectstringWhat the item does to the service and its clients
fromstringrequiredkeptbooleanA kept extension: it exists in a database, and the service does not ask for it
labelstringThe name of the item for the user
namestringrequirednotestringMore about the item: the other services of a shared item, or why it is required
reasonstringWhy Check added the item
releasestringThe release of the components pack or of the server packages of the target
requiredbooleanA server runs a version below the compatibility floor of the console (console/catalog/components.yml). Check adds the item; Reason tells why.
serversstring[]The servers that the item moves
servicesstring[]The other services that use the servers of a shared item (a backup server, a standalone DCS cluster)
sourcestringWhere the target comes from, for example components pack v0.12.0
stepstringHow a component item moves. rolling_pass: in the down window of each server of the rolling pass. member_by_member: one server at a time, with a health wait, no PostgreSQL restart. in_place: on each server, no PostgreSQL restart. pgbackrest_group: every server of the backup group in one step, no PostgreSQL restart. tailscale: one server at a time, a short mesh interruption.
rolling_passmember_by_memberin_placepgbackrest_grouptailscaletostringrequiredmissing_optionalstring[]requiredreleasestringrequiredlast_checkUpgradeCheckReportShow propertiesHide properties
backupUpgradeBackupInforequiredThe backup state, for a Back up now action (the backup operation). The upgrade never takes a backup.
Show propertiesHide properties
can_back_upbooleanrequiredA backup can start now: backups are configured and no backup runs
configuredbooleanrequiredThe service has backups configured
last_backup_atstringThe stop time of the newest successful backup
runningbooleanrequiredA backup runs now
backup_risksstring[]requiredThe backup warnings of the check. Upgrade needs accept_backup_risk when there is one.
currentbooleanrequiredThe service still has the versions, the pin and the servers that the check read, and no restore started after the check. Upgrade runs the plan only then.
livesync_pauseLivesyncPauseThe LiveSync sessions that Upgrade stops and starts again. Upgrade needs livesync_sessions with exactly these IDs.
Show propertiesHide properties
in_placebooleanrequiredThe service is the source of a LiveSync session: the leader restarts in place, with no switchover, so that the replication slot stays on it
refusalstringWhy the console cannot pause a LiveSync session of the service
sessionsLivesyncPausedSession[]requiredThe running LiveSync sessions that the action stops and starts again
Show propertiesHide properties
LivesyncPausedSessionidstringrequirednamestringrequiredno_slotbooleanThe source had no replication slot of the session after the stop
resultstringWhat the start after the action did
sidestringrequiredsourcetargetslot_lsnstringThe confirmed position of the replication slot after the stop
slot_seenbooleanThe replication slot of the session was on the source after the stop
stepbooleanThe action stops or starts the LiveSync sessions now
passedbooleanrequiredThe check completed with no failed row
planUpgradePlanrequiredThe resolved selection: the picked items, the items that Check added with their reason, and the blockers
Show propertiesHide properties
blockersstring[]requireditemsUpgradeItem[]requiredmissing_optionalstring[]requiredreleasestringrequiredrequestUpgradeRequest[]requiredShow propertiesHide properties
UpgradeRequestnamestringrequiredpostgresql, 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
targetstringThe 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.
rowsUpgradeCheckRow[]requiredShow propertiesHide properties
UpgradeCheckRowcheckstringrequiredpackagesitemsbackuppgbackrestwriteslivesyncpatronidcstransactionsdatallowconnupdate_pathsoptional_extensionsinstallrollback_versionsdiskpgbackrest_groupdcs_clusterdatabasestringThe database of a row of one database
detailstringrequiredserverstringThe server of a row of one server
statusstringrequiredpasswarnfailstarted_atstringrequiredstatusstringrequiredThe status of the check workflow
runningcompletedfailedtimeoutinterruptedupgradedbooleanrequiredAn Upgrade with the plan of this check completed. Upgrade runs a check once: run Check again for the next upgrade.
workflow_idstringrequiredlast_upgradeUpgradeRunReportShow propertiesHide properties
actorstringWho started the upgrade
finished_atstringitemsUpgradeItem[]requiredThe items of the plan, each from its version before the upgrade to its target
Show propertiesHide properties
UpgradeItemaddedbooleanCheck added the item, because a picked item needs it
effectstringWhat the item does to the service and its clients
fromstringrequiredkeptbooleanA kept extension: it exists in a database, and the service does not ask for it
labelstringThe name of the item for the user
namestringrequirednotestringMore about the item: the other services of a shared item, or why it is required
reasonstringWhy Check added the item
releasestringThe release of the components pack or of the server packages of the target
requiredbooleanA server runs a version below the compatibility floor of the console (console/catalog/components.yml). Check adds the item; Reason tells why.
serversstring[]The servers that the item moves
servicesstring[]The other services that use the servers of a shared item (a backup server, a standalone DCS cluster)
sourcestringWhere the target comes from, for example components pack v0.12.0
stepstringHow a component item moves. rolling_pass: in the down window of each server of the rolling pass. member_by_member: one server at a time, with a health wait, no PostgreSQL restart. in_place: on each server, no PostgreSQL restart. pgbackrest_group: every server of the backup group in one step, no PostgreSQL restart. tailscale: one server at a time, a short mesh interruption.
rolling_passmember_by_memberin_placepgbackrest_grouptailscaletostringrequiredreleasestringrequiredThe release of the plan
started_atstringrequiredstatusstringrequiredThe status of the upgrade workflow
runningcompletedfailedtimeoutinterruptedworkflow_idstringrequiredoptionsUpgradeOption[]requiredEach package item with each target that the loaded server packages have for it, newest first, also from newer releases. Each target has its release and the items that Check adds with it (TSE-1066).
Show propertiesHide properties
UpgradeOptionfromstringrequiredThe installed version. For Patroni, pgBouncer, HAProxy and keepalived, the version of the pinned pack.
keptbooleanA kept extension: it exists in a database, and the service does not ask for it
namestringrequiredtargetsUpgradeTarget[]requiredEach version above the installed version that the pinned pack or a newer loaded release has, newest first
Show propertiesHide properties
UpgradeTargetmoves_pinbooleanOnly a newer release has the target: the upgrade moves the pin
needsUpgradeNeed[]requiredThe items that Check adds when the request picks this item alone at this version
Show propertiesHide properties
UpgradeNeednamestringrequiredThe item, for example postgresql
reasonstringrequiredWhy the target needs the item
tostringrequiredThe version of the item that the target needs
releasestringrequiredThe release of the target: the pin after an upgrade of this item alone
versionstringrequiredrecheckstringWhy Check can find an item that available does not have: the last upgrade did not complete, or a restore ran after the last check. Check then finds the catalog step of an extension whose catalog is behind its package (ADR 2026-10-21 decision 21).
refusalstringWhy the console cannot offer an upgrade now, for example the pinned server packages are not loaded
upgrade_refusalstringWhy Upgrade is refused now while Check can run: the console still checks the nofailover tag and the pause of Patroni after the last service upgrade
Error
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message