databases
DELETE /v1/databases/{databaseId}
Delete a managed database and its backups.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X DELETE https://api.zinndigital.com/v1/databases/{databaseId} \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
Gated on `databases.manage`. Returns `202` — the instance moves to `deleting` and **stops accruing charges at that moment**, not when the last volume detaches; teardown latency is ours, not the customer's. ⛔ Irreversible: the cluster, its volumes and its backup chain all go.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
databaseId (path) | string | Sim | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | string | Sim | — |
label | string | Sim | The customer's own name for it. Never sent to the infrastructure. |
engine | string<postgres, mysql> | Sim | 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 | Sim | 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 | Não | 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 | Sim | A code from `GET /v1/databases/catalogue`. |
status | string<provisioning, available, failed, suspended, deleting, deleted> | Sim | — |
status_detail | string | Não | Why a `failed` instance failed. Empty otherwise. |
host | string | Não | Empty until the instance is `available`. |
port | integer | Sim | — |
database_name | string | Sim | — |
username | string | Sim | — |
high_availability | boolean | Sim | 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 | Não | — |
ram_gb | integer | Não | — |
storage_gb | integer | Não | — |
tls_required | boolean | Sim | Always true. TLS is a precondition of selling a publicly reachable database, not a feature that can be turned off. |
created_at | string | Sim | — |
last_backup_at | string | Não | When a backup last **completed**. `null` means none has ever run. |
order_line_id | object | Não | 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 | Não | 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 | Não | 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… |
Erros que este endpoint pode retornar
401 · 403 · 404