hosting
POST /v1/site-imports/{importId}/cancel
Cancel a running import.
Ìfàṣẹ́pọ̀
Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda hosting.import.manage; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.
Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.
Gbiyanju rẹ
Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.
curl -X POST https://api.zinndigital.com/v1/site-imports/{importId}/cancel \
-H "Authorization: Bearer zdk_live_…"Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API
Àwọn kúlẹ̀kúlẹ̀
Marks the job cancelled. The running workflow notices at the top of its next fetch batch and stops cleanly, which leaves the job's rows consistent — cancelling the workflow itself would abort mid-batch with items half-written. An already-finished job returns 422. Requires hosting.import.manage.
Àwọn ìpìlẹ̀
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
importId (path) | Uuid | Bẹẹni | Site-import job ID (UUIDv7). |
Idahun
| Orúkọ | Iru | Tí a nílò | Kini o jẹ |
|---|---|---|---|
id | Uuid | Bẹẹni | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | string | Bẹẹkọ | 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 | Bẹẹni | 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 | Bẹẹni | What the import produces. Both are supported; neither is a default. |
status | SiteImportStatus | Bẹẹni | 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 | Bẹẹkọ | 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 | Bẹẹni | — |
target_domain | string | Bẹẹkọ | — |
snapshot_day | string | Bẹẹkọ | — |
crawl_depth | integer | Bẹẹkọ | — |
urls_total | integer | Bẹẹni | — |
urls_done | integer | Bẹẹni | — |
urls_failed | integer | Bẹẹni | — |
detected_platform | string | Bẹẹkọ | 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 | Bẹẹkọ | 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 | Bẹẹni | For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say which step. |
requests_spent | integer | Bẹẹni | — |
request_budget | integer | Bẹẹni | — |
budget_exhausted | boolean | Bẹẹni | 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 | Bẹẹkọ | — |
created_at | string | Bẹẹni | — |
started_at | string | Bẹẹkọ | — |
finished_at | string | Bẹẹkọ | — |
can_cancel | boolean | Bẹẹni | — |
Awọn aṣiṣe ti ibudo ipari yii le da pada
401 · 403 · 404 · 422 · 429