인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 hosting.import.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X POST https://api.zinndigital.com/v1/site-imports/{importId}/cancel \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
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`.
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
importId (path) | Uuid | 예 | Site-import job ID (UUIDv7). |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
id | Uuid | 예 | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | string | 아니요 | 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 | 예 | 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 | 예 | What the import produces. Both are supported; neither is a default. |
status | SiteImportStatus | 예 | `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 | 아니요 | 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 | 예 | — |
target_domain | string | 아니요 | — |
snapshot_day | string | 아니요 | — |
crawl_depth | integer | 아니요 | — |
urls_total | integer | 예 | — |
urls_done | integer | 예 | — |
urls_failed | integer | 예 | — |
progress_percent | integer | 예 | For a progress bar only. The per-URL counters are the primary display, because a percentage cannot say *which* step. |
requests_spent | integer | 예 | — |
request_budget | integer | 예 | — |
budget_exhausted | boolean | 예 | 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 | 아니요 | — |
created_at | string | 예 | — |
started_at | string | 아니요 | — |
finished_at | string | 아니요 | — |
can_cancel | boolean | 예 | — |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 404 · 422 · 429