hosting

POST /v1/site-imports/{importId}/cancel

Cancel a running import.

ټول hosting پای ټکي

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د hosting.import.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

curl -X POST https://api.zinndigital.com/v1/site-imports/{importId}/cancel \
  -H "Authorization: Bearer zdk_live_…"

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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).

ځواب

نومډولاړیندا څه شی دی
idUuidهوUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idstringنه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.
sourceSiteImportSourceهو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…
outputSiteImportOutputهوWhat the import produces. Both are supported; neither is a default.
statusSiteImportStatusهو`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_reasonstringنه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_domainstringهو
target_domainstringنه
snapshot_daystringنه
crawl_depthintegerنه
urls_totalintegerهو
urls_doneintegerهو
urls_failedintegerهو
progress_percentintegerهوFor a progress bar only. The per-URL counters are the primary display, because a percentage cannot say *which* step.
requests_spentintegerهو
request_budgetintegerهو
budget_exhaustedbooleanهو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_bytesintegerنه
created_atstringهو
started_atstringنه
finished_atstringنه
can_cancelbooleanهو

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 422 · 429