databases
POST /v1/databases/{databaseId}/upgrade
Move the database to a newer PostgreSQL major.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
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> }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
databaseId (path) | string | Да | — |
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
engine_version | string | Да | 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:… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | string | Да | — |
label | string | Да | The customer's own name for it. Never sent to the infrastructure. |
engine | string<postgres, mysql> | Да | 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 | Да | 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 run… |
engine_label | string | Нет | 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 | Да | A code from GET /v1/databases/catalogue. |
status | string<provisioning, available, failed, suspended, deleting, deleted> | Да | — |
status_detail | string | Нет | Why a failed instance failed. Empty otherwise. |
host | string | Нет | Empty until the instance is available. |
port | integer | Да | — |
database_name | string | Да | — |
username | string | Да | — |
high_availability | boolean | Да | 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… |
vcpu | integer | Нет | — |
ram_gb | integer | Нет | — |
storage_gb | integer | Нет | — |
tls_required | boolean | Да | Always true. TLS is a precondition of selling a publicly reachable database, not a feature that can be turned off. |
created_at | string | Да | — |
last_backup_at | string | Нет | When a backup last completed. null means none has ever run. |
order_line_id | object | Нет | 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 | Нет | 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… |
restore_verified_at | string | Нет | 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… |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422