databases

POST /v1/databases/{databaseId}/upgrade

Move the database to a newer PostgreSQL major.

Všechny koncové body databases

Všechny dokumenty pro vývojáře

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/databases/{databaseId}/upgrade \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "engine_version": <string> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Gated on databases.manage. Returns 202 — the upgrade runs as a durable workflow because the operator rolls the primary over to an upgraded replica, which takes minutes and must survive a deploy or the customer closing the tab. ⛔ Refused with 422 when the target is not a major we run, when it is not newer than the current one (downgrading is not possible), and — importantly — when the database has never been backed up: if a switchover goes wrong the way back is a restore, and a restore with no backup is not a way back.

Parametry

NázevTypPožadovánoCo to je
databaseId (path)stringAno

Tělo požadavku

NázevTypPožadovánoCo to je
engine_versionstringAnoThe engine major to move to. Must be one this platform offers for the database's own engine, and newer than its current one. ⛔ Compared as version numbers, not as text:…

Odpověď

NázevTypPožadovánoCo to je
idstringAno
labelstringAnoThe customer's own name for it. Never sent to the infrastructure.
enginestring<postgres, mysql>AnoWhich engine this database runs (docs/497). Modelled as a field from the start, which is why MySQL was additive rather than a migration of every row.
engine_versionstringAnoThe engine's major"18", "8.4". The patch level is ours to keep current and is deliberately not customer-selectable: choosing your own patch level means choosing to run…
engine_labelstringNeThe engine and version as a customer sees them — "PostgreSQL 18", "MySQL 8.4". Assembled by the API so three frontends cannot disagree about a product name.
sizestringAnoA code from GET /v1/databases/catalogue.
statusstring<provisioning, available, failed, suspended, deleting, deleted>Ano
status_detailstringNeWhy a failed instance failed. Empty otherwise.
hoststringNeEmpty until the instance is available.
portintegerAno
database_namestringAno
usernamestringAno
high_availabilitybooleanAnoWhether a standby replica is held with automatic failover. The property customers actually choose on — stated rather than inferred from the size, because an inference goes…
vcpuintegerNe
ram_gbintegerNe
storage_gbintegerNe
tls_requiredbooleanAnoAlways true. TLS is a precondition of selling a publicly reachable database, not a feature that can be turned off.
created_atstringAno
last_backup_atstringNeWhen a backup last completed. null means none has ever run.
order_line_idobjectNeThe paid basket line this database fulfils, or null for one that predates the purchase path or that staff tooling created. The subscription that bills it carries the same id.
billingManagedDatabaseBillingNeThe subscription paying for this database — what it costs, and when it next renews. ⛔ null means no subscription pays for it, which is a real state (a row created before…
restore_verified_atstringNeWhen a backup of this database was last proved restorable by restoring it and reading a row back over a client connection. ⛔ Deliberately separate from last_backup_at: a…

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422