hosting

POST `/v1/site-imports`

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

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie hosting.import.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

Nazwa	Typ	Wymagane	Co to jest
`Idempotency-Key (header)`	`string`	Nie	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`source`	`SiteImportSource`	Tak	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`	Tak	What the import produces. Both are supported; neither is a default.
`source_domain`	`string`	Tak	The domain whose archive to restore, or — for `archive_url` — the URL of the archive to migrate in.
`target_domain`	`string`	Nie	The domain the result is served on. Defaults to `source_domain`.
`site_id`	`Uuid`	Nie	Restore into an existing site. Omit to produce a bundle and choose the target later.
`snapshot_day`	`string`	Nie	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`	Nie	—
`request_budget`	`integer`	Nie	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`	Nie	⚠️ 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.

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`Uuid`	Tak	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`site_id`	`string`	Nie	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`	Tak	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`	Tak	What the import produces. Both are supported; neither is a default.
`status`	`SiteImportStatus`	Tak	`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`	Nie	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`	Tak	—
`target_domain`	`string`	Nie	—
`snapshot_day`	`string`	Nie	—
`crawl_depth`	`integer`	Nie	—
`urls_total`	`integer`	Tak	—
`urls_done`	`integer`	Tak	—
`urls_failed`	`integer`	Tak	—
`progress_percent`	`integer`	Tak	For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say which step.
`requests_spent`	`integer`	Tak	—
`request_budget`	`integer`	Tak	—
`budget_exhausted`	`boolean`	Tak	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`	Nie	—
`created_at`	`string`	Tak	—
`started_at`	`string`	Nie	—
`finished_at`	`string`	Nie	—
`can_cancel`	`boolean`	Tak	—

Błędy, które ten punkt końcowy może zwrócić

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

POST /v1/site-imports