hosting
GET /v1/sites/{siteId}/backups
List a site's backups and what its plan grants.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/backups \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
A cheap database read, polled while a backup is in flight, so it never calls the hosting adapter or object storage. offsite_enabled is reported deliberately: when it is false every backup lives on the same host as the site, so a host loss takes both — the customer is entitled to know that before they need a restore. Requires sites.view.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 · 429