hosting
POST /v1/sites/{siteId}/backups/{backupId}/download
Mint a time-limited download URL for one of a site's backups.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung hosting.backup.export verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/backups/{backupId}/download \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
backupId (path) | Uuid | Ja | 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… |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
url | string | Ja | 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 | Ja | 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 | Ja | 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 | Ja | 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. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422 · 429