hosting
POST /v1/sites/deleted/{deletedSiteId}/restore
Restore a deleted site.
認証
ベアラー トークンとして API キーを送信します。キーには sites.create 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/deleted/{deletedSiteId}/restore \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Brings a deleted site back. Answers 202 — the site is rebuilt by a workflow, and returns to suspended rather than active until it is actually serving again. ⛔ The guard is re-evaluated on this request, never trusted from the button. Between the list rendering and the click the customer may have recreated a site on the same domain, the retention window may have closed, or the purge may have run. A 422 carries the machine-readable reason (no_backup, purged, domain_in_use, already_restored, abuse_hold) so the client can say which it was. Requires sites.create as well as sites.view: a restore creates a live site.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
deletedSiteId (path) | Uuid | はい | The DeletedSite record id (not the site id). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | はい | The site this was. May no longer exist as a row. |
org_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
primary_domain | string | はい | — |
reason | string<dunning, customer, staff, abuse> | はい | Why it was deleted. abuse is restorable by staff only — a one-click customer restore of a site removed for terms enforcement would undo the enforcement. |
deleted_at | string | はい | Soft delete — removed from serving. The data is still here. |
deleted_by | string | いいえ | — |
purge_due_at | string | いいえ | When the backup is purged and the site becomes permanently unrecoverable. ⛔ Computed by the engine from the live retention policy, by the same function the purge sweep selects… |
purged_at | string | いいえ | Hard delete. Non-null means the data is gone and no restore is possible. |
restored_at | string | いいえ | — |
restorable | boolean | はい | Whether a restore would succeed right now. Reflects a real check that the backup object exists in storage — not a status column. |
reason_code | string<, no_backup, purged, domain_in_use, already_restored, abuse_hold> | はい | Empty when restorable. Otherwise one of no_backup, purged, domain_in_use, already_restored, abuse_hold. ⛔ A code, rendered by the client through its own catalogue —… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503