hosting
POST /v1/site-imports/{importId}/cancel
Cancel a running import.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso hosting.import.manage; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X POST https://api.zinndigital.com/v1/site-imports/{importId}/cancel \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
importId (path) | Uuid | Sí | Site-import job ID (UUIDv7). |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
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í | — |
detected_platform | string | No | 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 | No | 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 behi… |
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í | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 422 · 429