hosting

POST /v1/site-imports

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

Të gjitha pikat e skajshme hosting

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen hosting.import.manage; një çelës pa të refuzohet me 403, jo 404.

Ky pikëndalim nuk pranon id të organizatës. Çelësi juaj tashmë identifikon organizatën së cilës i përket dhe përgjigjja kufizohet vetëm për atë.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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

Parametrat

EmriLlojiKërkohetÇfarë është kjo
Idempotency-Key (header)stringJoClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Trupi i kërkesës

EmriLlojiKërkohetÇfarë është kjo
sourceSiteImportSourcePoWhere 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…
outputSiteImportOutputPoWhat the import produces. Both are supported; neither is a default.
source_domainstringPoThe domain whose archive to restore, or — for `archive_url` — the URL of the archive to migrate in.
target_domainstringJoThe domain the result is served on. Defaults to `source_domain`.
site_idUuidJoRestore into an existing site. Omit to produce a bundle and choose the target later.
snapshot_daystringJoWhich 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_depthintegerJo
request_budgetintegerJoThe 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_attestedbooleanJo⚠️ 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.

Përgjigja

EmriLlojiKërkohetÇfarë është kjo
idUuidPoUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idstringJoThe 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.
sourceSiteImportSourcePoWhere 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…
outputSiteImportOutputPoWhat the import produces. Both are supported; neither is a default.
statusSiteImportStatusPo`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_reasonstringJoA 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_domainstringPo
target_domainstringJo
snapshot_daystringJo
crawl_depthintegerJo
urls_totalintegerPo
urls_doneintegerPo
urls_failedintegerPo
progress_percentintegerPoFor a progress bar only. The per-URL counters are the primary display, because a percentage cannot say *which* step.
requests_spentintegerPo
request_budgetintegerPo
budget_exhaustedbooleanPoTrue 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_bytesintegerJo
created_atstringPo
started_atstringJo
finished_atstringJo
can_cancelbooleanPo

Gabimet që ky pikëndalim mund të kthejë

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