hosting
POST /v1/offsite-destinations/{destinationId}/key
Show the encryption key, so a copy can be opened without us.
Authentication
Send an API key as a bearer token. The key must carry the hosting.backup.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/offsite-destinations/{destinationId}/key \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
POST so the key never sits in a browser history or a proxy log; audited every time. With the IV from the .json sidecar beside each archive: openssl enc -d -aes-256-ctr -K <key_hex> -iv <iv> -in site.tar.gz.enc -out site.tar.gz. Requires hosting.backup.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
destinationId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
algorithm | string<aes-256-ctr> | Yes | — |
key_hex | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422