hosting

POST `/v1/site-imports`

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

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění hosting.import.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Název	Typ	Požadováno	Co to je
`Idempotency-Key (header)`	`string`	Ne	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Tělo požadavku

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

Odpověď

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

Chyby, které může tento koncový bod vrátit

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

POST /v1/site-imports