hosting
POST /v1/sites/{siteId}/backups/{backupId}/download
Mint a time-limited download URL for one of a site's backups.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão hosting.backup.export; uma chave sem ela é recusada com 403, e não 404.
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 POST https://api.zinndigital.com/v1/sites/{siteId}/backups/{backupId}/download \
-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
Returns a presigned URL the customer's browser fetches **directly from object storage**; the archive never passes through the control plane. A site archive is measured in gigabytes, so proxying it would make the customer's site size our memory ceiling and hold a request thread for the length of the transfer. ⛔ **`POST`, despite reading nothing.** The response body is a bearer credential for the whole site — database included — so a `GET` would invite it into browser history, proxy logs and shared caches, and the audit row this writes would be created by every prefetch. The grant expires; take a new one rather than storing it. A backup that never produced a stored archive is `422` (`backup_not_downloadable`) rather than a signature over a key that is not there, which object storage would reject seconds later as an opaque `404`. Requires `hosting.backup.export` — or `hosting.backup.manage`, which every holder of the old gate still has — and never `sites.view`: reading a tenant's database out is never a viewer's. A per-site *editor* holds `hosting.backup.export`, which is how `zinnector pull` brings the files down for local development without being able to restore.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
backupId (path) | Uuid | Sim | The backup's id (UUIDv7), as `getSiteBackups` reports it. **Ours**, minted when the row was written — never the storage key, which is an internal object path and is deliberately… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
url | string | Sim | The presigned object-storage URL to fetch the archive from. Hand it straight to the customer's browser and let it expire; take a fresh grant rather than caching this one. |
expires_at | string | Sim | When the signature stops working. A download that has already started is unaffected; a new one after this moment is refused by storage. |
size_bytes | integer | Sim | The archive's size, as object storage reported it when the backup was stored — so a client can warn before a multi-gigabyte download. |
etag | string | Sim | The stored object's entity tag, for a client that wants to verify the bytes it received are the bytes we hold. Empty when the backend did not report one. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429