hosting
POST /v1/site-imports
Restore a site from a web archive, or migrate one in.
認証
ベアラー トークンとして API キーを送信します。キーには hosting.import.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/site-imports \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "source": <SiteImportSource>, "output": <SiteImportOutput>, "source_domain": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Starts a durable, resumable import workflow and returns the new job state, never a bare acknowledgement. A Wayback restore must name snapshot_day: the most recent capture of an expired domain is usually a parking page, so there is no safe default (422 without it). The output is either a static HTML document root or a WordPress import — both are supported and neither is a default. A site with an import already running returns 409. ⚠️ ownership_attested is recorded, not enforced: the platform's obligation here is to know who requested what. Requires hosting.import.manage.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id | Uuid | いいえ | Which organisation this import belongs to. Only needed by an account that acts for more than one and is not naming a site_id — when a site is named, the site decides,… |
source | SiteImportSource | はい | Where the content comes from. ⛔ Deliberately not the same enum as a site's source: that one records what a site was built from, for ever, while this selects a fetch strategy and… |
output | SiteImportOutput | はい | What the import produces. Both are supported; neither is a default. |
source_domain | string | はい | The domain whose archive to restore, or — for archive_url — the URL of the archive to migrate in. |
target_domain | string | いいえ | The domain the result is served on. Defaults to source_domain. |
site_id | Uuid | いいえ | Restore into an existing site. Omit to produce a bundle and choose the target later. |
snapshot_day | string | いいえ | Which day's snapshot to restore. Required for wayback — the most recent capture of an expired domain is usually a parking page, so there is no safe default. |
crawl_depth | integer | いいえ | — |
request_budget | integer | いいえ | The hard ceiling on requests this job may make against the source. Bounded per job so one 400,000-capture domain cannot consume the platform's whole archive allowance. |
ownership_attested | boolean | いいえ | ⚠️ The customer's assertion that they control the domain, recorded because it cannot be reconstructed afterwards. It is not a legal control and is not presented as one. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | string | いいえ | The site this import lands on, or empty. Empty is a real outcome, not an error: an aged-domain restore produces a downloadable bundle and the customer picks the target afterwards. |
source | SiteImportSource | はい | Where the content comes from. ⛔ Deliberately not the same enum as a site's source: that one records what a site was built from, for ever, while this selects a fetch strategy and… |
output | SiteImportOutput | はい | What the import produces. Both are supported; neither is a default. |
status | SiteImportStatus | はい | fetching and building are separate states rather than one running because they fail for opposite reasons and the customer's next action differs — a stall in fetching is… |
status_reason | string | いいえ | A machine code the dashboard renders through its own catalogue — never an English sentence composed by the engine, which could not be shown to the other 57 locales. |
source_domain | string | はい | — |
target_domain | string | いいえ | — |
snapshot_day | string | いいえ | — |
crawl_depth | integer | いいえ | — |
urls_total | integer | はい | — |
urls_done | integer | はい | — |
urls_failed | integer | はい | — |
detected_platform | string | いいえ | What the archived site was built on, once the crawl has seen a page — the same codes as ArchivePlatform.platform. ⛔ Empty means not established, never plain HTML; the two… |
pre_restore_backup_id | string | いいえ | The safety backup taken of the target site immediately before this restore overwrote it. ⚖️ Owner ruling 2026-09-08: a restore onto a site that already has content is gated behind… |
progress_percent | integer | はい | For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say which step. |
requests_spent | integer | はい | — |
request_budget | integer | はい | — |
budget_exhausted | boolean | はい | True when the job stopped because it ran out of requests. Surfaced deliberately — it otherwise looks identical to a job that finished, and the customer's next action depends on… |
bundle_bytes | integer | いいえ | — |
created_at | string | はい | — |
started_at | string | いいえ | — |
finished_at | string | いいえ | — |
can_cancel | boolean | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 503