hosting

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

Cancel a running import.

සියලුම hosting අන්ත ලක්ෂ්‍ය

සත්‍යාපනය

බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. යතුරෙහි hosting.import.manage අවසරය තිබිය යුතුය; එය නොමැති යතුරක් 404 ලෙස නොව 403 ලෙස ප්‍රතික්ෂේප කෙරේ.

මෙම අවසාන ලක්ෂ්‍යය සඳහා සංවිධාන හැඳුනුම්පතක් (organisation id) අවශ්‍ය නොවේ. ඔබගේ යතුර මඟින් එය අයත් වන සංවිධානය දැනටමත් හඳුනා ගන්නා අතර, ප්‍රතිචාරය ඒ වෙත සීමා වේ.

උත්සාහ කරන්න

<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්‍රතිස්ථාපනය කරන්න.

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

පද්ධතියට පිවිස සිටිනවාද? ඔබගේ උපකරණ පුවරුවේ ඇති API කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී 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).

පsspil

නමවර්ගයඅත්‍යවශ්‍යයිඑය කුමක්ද
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ඔව්
detected_platformstringනැත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_idstringනැත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_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