hosting

PUT `/v1/sites/{siteId}/offsite`

Send this site's backups to a destination.

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 PUT https://api.zinndigital.com/v1/sites/{siteId}/offsite \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "destination_id": <string>, "retention_days": <integer<7, 30, 90, 180, 365>> }'

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

Requires the add-on for this site and an account in good standing. Switching on copies the newest restorable backup (and any archives it depends on) at once, then every later backup. Changing destination drops copies still waiting for the old one; stored copies stay. Requires hosting.backup.manage.

Parameters

Name	Type	Required	What it is
`siteId (path)`	`Uuid`	Yes	Site ID (UUIDv7).

Request body

Name	Type	Required	What it is
`destination_id`	`string`	Yes	—
`retention_days`	`integer<7, 30, 90, 180, 365>`	Yes	—
`enabled`	`boolean`	No	—

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 · 422

PUT /v1/sites/{siteId}/offsite