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

Upgrade a database service

Runs the resolved selection of the last Check (ADR 2026-10-21 decision items 3 to 7): the pgBackRest step of the backup group, the rolling package pass (HA: the replicas one at a time, one switchover, the catalog step on the new leader, then the old leader; Standard: one stop and start), then the catalog step, then the component steps with no PostgreSQL restart, then Tailscale one server at a time (decision 30). The workflow is upgrade_service. 409 when the last Check did not pass, has no item, is older than one hour, was used by an Upgrade that completed, or no longer matches the service or the loaded server packages, when an operation runs on another service of a shared item, and when the Check warns about the backups and accept_backup_risk is not true.

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

Upgrade although the last Check warns about the backups: no backups configured, no successful backup in 24 hours, or WAL archiving not healthy (decision 6). The audit log records it.

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' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "accept_backup_risk": true
}'
Response
{
  "workflow_id": "string"
}