hosting
POST /v1/sites/{siteId}/backups/restore
Restore a site from one of its backups.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 hosting.backup.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
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 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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