hosting

POST `/v1/site-imports`

Restore a site from a web archive, or migrate one in.

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar hosting.import.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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> }'

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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`.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`Idempotency-Key (header)`	`string`	Hayır	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`source`	`SiteImportSource`	Evet	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 a…
`output`	`SiteImportOutput`	Evet	What the import produces. Both are supported; neither is a default.
`source_domain`	`string`	Evet	The domain whose archive to restore, or — for `archive_url` — the URL of the archive to migrate in.
`target_domain`	`string`	Hayır	The domain the result is served on. Defaults to `source_domain`.
`site_id`	`Uuid`	Hayır	Restore into an existing site. Omit to produce a bundle and choose the target later.
`snapshot_day`	`string`	Hayır	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`	Hayır	—
`request_budget`	`integer`	Hayır	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`	Hayır	⚠️ 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.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`site_id`	`string`	Hayır	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`	Evet	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 a…
`output`	`SiteImportOutput`	Evet	What the import produces. Both are supported; neither is a default.
`status`	`SiteImportStatus`	Evet	`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`	Hayır	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`	Evet	—
`target_domain`	`string`	Hayır	—
`snapshot_day`	`string`	Hayır	—
`crawl_depth`	`integer`	Hayır	—
`urls_total`	`integer`	Evet	—
`urls_done`	`integer`	Evet	—
`urls_failed`	`integer`	Evet	—
`progress_percent`	`integer`	Evet	For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say which step.
`requests_spent`	`integer`	Evet	—
`request_budget`	`integer`	Evet	—
`budget_exhausted`	`boolean`	Evet	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`	Hayır	—
`created_at`	`string`	Evet	—
`started_at`	`string`	Hayır	—
`finished_at`	`string`	Hayır	—
`can_cancel`	`boolean`	Evet	—

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 409 · 422 · 429 · 503

POST /v1/site-imports