Sign in
Postgres Upgrades

Start a new PostgreSQL major-version upgrade for a service.

Changed on
post/external-services/{service_id}/upgrades

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/external-services/{service_id}/upgrades
  • Auth: HTTP bearer

Path parameters

service_idinteger required

External service id

Request body

from_imagestring required
from_versionstring required
to_imagestring required
to_versionstring required

Example request

{
  "from_image": "postgres:16-bookworm",
  "from_version": "16",
  "to_image": "postgres:17-bookworm",
  "to_version": "17"
}

Response

Upgrade started

attemptinteger required
created_atstring required
error_messagestring nullable
finished_atstring nullable
from_imagestring required
from_versionstring required
idinteger required
log_idstring required
phasestring required
pre_upgrade_backup_idinteger nullable
rollback_volume_namestring nullable
service_idinteger required
started_atstring nullable
statusstring required
to_imagestring required
to_versionstring required

Changes

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status