hosting
GET /v1/sites/{siteId}/offsite
Where this site's backups are copied offsite, and every copy made.
Authentication
Send an API key as a bearer token. The key must carry the sites.view 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 GET https://api.zinndigital.com/v1/sites/{siteId}/offsite \
-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
entitled says whether the paid add-on (extra_code) is active for this site. Copies reach the destination within about ten minutes of a backup finishing. Gated on sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
entitled | boolean | Yes | — |
extra_code | string | Yes | — |
retention_choices | integer[] | Yes | — |
policy | object | Yes | — |
copies | OffsiteCopy[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404