Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione hosting.import.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/site-imports/{importId}/cancel \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
importId (path) | Uuid | Sì | Site-import job ID (UUIDv7). |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | string | No | 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 | Sì | 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 | Sì | What the import produces. Both are supported; neither is a default. |
status | SiteImportStatus | Sì | `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 | No | 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 | Sì | — |
target_domain | string | No | — |
snapshot_day | string | No | — |
crawl_depth | integer | No | — |
urls_total | integer | Sì | — |
urls_done | integer | Sì | — |
urls_failed | integer | Sì | — |
progress_percent | integer | Sì | For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say *which* step. |
requests_spent | integer | Sì | — |
request_budget | integer | Sì | — |
budget_exhausted | boolean | Sì | 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 | No | — |
created_at | string | Sì | — |
started_at | string | No | — |
finished_at | string | No | — |
can_cancel | boolean | Sì | — |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422 · 429