databases
POST /v1/databases/{databaseId}/upgrade
Move the database to a newer PostgreSQL major.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
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> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
databaseId (path) | string | Ja | — |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
engine_version | string | Ja | The 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: `"9.7" <… |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | string | Ja | — |
label | string | Ja | The customer's own name for it. Never sent to the infrastructure. |
engine | string<postgres, mysql> | Ja | Which 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_version | string | Ja | The 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 ru… |
engine_label | string | Nee | The 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. |
size | string | Ja | A code from `GET /v1/databases/catalogue`. |
status | string<provisioning, available, failed, suspended, deleting, deleted> | Ja | — |
status_detail | string | Nee | Why a `failed` instance failed. Empty otherwise. |
host | string | Nee | Empty until the instance is `available`. |
port | integer | Ja | — |
database_name | string | Ja | — |
username | string | Ja | — |
high_availability | boolean | Ja | Whether 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 w… |
vcpu | integer | Nee | — |
ram_gb | integer | Nee | — |
storage_gb | integer | Nee | — |
tls_required | boolean | Ja | Always true. TLS is a precondition of selling a publicly reachable database, not a feature that can be turned off. |
created_at | string | Ja | — |
last_backup_at | string | Nee | When a backup last **completed**. `null` means none has ever run. |
order_line_id | object | Nee | The 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. |
billing | ManagedDatabaseBilling | Nee | The 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 d… |
restore_verified_at | string | Nee | When 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 b… |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422