Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie hosting.import.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/site-imports/{importId}/cancel \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
importId (path) | Uuid | Ja | Site-import job ID (UUIDv7). |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | string | Nee | 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 | Ja | 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 | Ja | What the import produces. Both are supported; neither is a default. |
status | SiteImportStatus | Ja | `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 | Nee | 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 | Ja | — |
target_domain | string | Nee | — |
snapshot_day | string | Nee | — |
crawl_depth | integer | Nee | — |
urls_total | integer | Ja | — |
urls_done | integer | Ja | — |
urls_failed | integer | Ja | — |
progress_percent | integer | Ja | For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say *which* step. |
requests_spent | integer | Ja | — |
request_budget | integer | Ja | — |
budget_exhausted | boolean | Ja | 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 | Nee | — |
created_at | string | Ja | — |
started_at | string | Nee | — |
finished_at | string | Nee | — |
can_cancel | boolean | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429