hosting
POST /v1/sites/{siteId}/backups/restore
Restore a site from one of its backups.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл hosting.backup.manage; ключ без нього відхиляється з кодом 403, а не 404.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/backups/restore \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "backup_id": <Uuid> }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
⛔ Destructive. This overwrites the site's live database and files with the contents of the named backup. Its own path rather than a verb on the collection, so it can never be reached by varying the body of the endpoint that takes backups. The backup must belong to this site and must have completed successfully; anything else is 422. Requires hosting.backup.manage.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
siteId (path) | Uuid | Так | Site ID (UUIDv7). |
Idempotency-Key (header) | string | Ні | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
backup_id | Uuid | Так | The backup to restore. Always named explicitly — there is no "restore the latest", because a destructive operation must not depend on which row happens to sort first. |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
site_id | Uuid | Так | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
backups | SiteBackup[] | Так | — |
can_backup | boolean | Так | False while a backup is in flight, when this site's hosting platform cannot take one at all, or when the site's on-demand allowance for the last 24 hours is spent. |
in_progress | boolean | Так | — |
on_demand_backups | boolean | Так | Always true. On-demand backups are included on every plan (owner ruling 2026-08-10); what bounds them is on_demand_limit per rolling 24 hours, not the plan. Retained for… |
unsupported_reason | string | Ні | A stable machine identifier saying why this site's hosting platform cannot be backed up at all, or empty when it can. The client renders it as a localised sentence. Distinct from… |
on_demand_limit | integer | Так | On-demand backups allowed per rolling 24 hours, per site. |
on_demand_used | integer | Так | On-demand backups taken in the last 24 hours. Failed attempts are not counted — the customer got nothing from them. |
on_demand_remaining | integer | Так | How many the customer may still take right now. |
on_demand_next_at | string | Так | When the next on-demand slot opens, as the oldest counted backup ages out of the rolling window. Null whenever on_demand_remaining is above zero. |
daily_backups | boolean | Так | The plan's daily_backups entitlement — whether the nightly sweep selects this site. |
retention_days | integer | Так | The plan's backup_retention_days entitlement, clamped to the platform maximum. |
offsite_enabled | boolean | Так | Whether object storage is configured. False means every backup stays on the worker host it was taken on. |
immutable | boolean | Так | Whether backup immutability is enforced and proven recently. True only when the platform's last reconciliation actually attempted to delete a canary object under the backup… |
immutable_days | integer | Так | How many days a written backup cannot be altered or deleted by anyone — us, a compromised site, or a stolen token. 30 by owner ruling (2026-08-12), matching sold retention; 0… |
immutability_verified_at | string | Так | When a delete was last actually attempted against the protected prefix and refused. ⛔ Not when the configuration was last read, and not when the reconciler last ran: a run that… |
immutability_reason | string | Так | A stable machine identifier saying why immutability is not currently provable — never_checked, no_rule, delete_succeeded, credential_missing, lock_api_unreachable,… |
restore_drill_passed | boolean | Так | Whether the platform's weekly restore drill last passed, and recently enough to still mean something. The drill restores a real stored backup onto a platform-owned site and… |
restore_drill_at | string | Так | When the last drill finished, whatever its outcome. Null when no drill has ever completed. |
restore_drill_reason | string | Так | A stable machine identifier saying why restores are not currently proven — never_drilled, no_drill_site, no_recent_backup, canary_unavailable, restore_failed,… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422 · 429 · 503