hosting
POST /v1/sites/{siteId}/migrations/{migrationId}/cancel
Stop a running migration.
توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس hosting.import.manage اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/migrations/{migrationId}/cancel \
-H "Authorization: Bearer zdk_live_…"لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں
تفصیلات
Marks the job cancelled. The running workflow notices at the top of its next round and stops cleanly, which leaves the item rows consistent and closes the session on the source host — cancelling the workflow itself would abort mid-item, with a half-written file on the new site and an open connection to somebody else's production server. An already-finished job returns 422 with migration_not_cancellable. Requires hosting.import.manage.
پیرامیٹرز
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
siteId (path) | Uuid | ہاں | Site ID (UUIDv7). |
migrationId (path) | Uuid | ہاں | The migration job's id (UUIDv7), as listSiteMigrations reports it. Ours, minted when the row was written — never anything the source host knows about. |
جواب
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
id | Uuid | ہاں | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | ہاں | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source | MigrationSource | ہاں | The kind of hosting the site is being pulled from. ⛔ plesk is offered so the refusal can be specific and actionable, not because it is supported: pleskbackup is reachable… |
status | SiteMigrationStatus | ہاں | authenticating, inventorying and transferring are separate states rather than one running because they fail for opposite reasons and the customer's next action differs: a… |
status_reason | string | نہیں | A machine code the dashboard renders through its own catalogue — never an English sentence composed by the engine, which could be shown to none of the other 57 locales. |
include_mail | boolean | ہاں | — |
source_host | string | نہیں | The hostname the estate is being pulled from. Host only: no port, no username, and never a secret. |
files_total | integer | ہاں | — |
files_done | integer | ہاں | — |
databases_total | integer | ہاں | — |
databases_done | integer | ہاں | — |
mailboxes_total | integer | ہاں | — |
mailboxes_done | integer | ہاں | — |
items_failed | integer | ہاں | ⛔ Counted separately from the *_done fields, never folded into them. "We could not get it" reported as "done" makes the completion report a lie. |
bytes_transferred | integer | ہاں | — |
warnings | string[] | ہاں | Machine warning codes the dashboard localises. |
mail_synced_at | string | نہیں | When the mail delta last ran. null and a timestamp are different states, and the cutover control reads this to tell them apart. |
dns_records_captured | integer | نہیں | How many records were read off the source's zone and will be published on cutover. ⛔ Counted separately from dns_records_unsupported, never as one total: "we captured 14… |
dns_records_unsupported | integer | نہیں | Real records the source holds that our DNS editor cannot express (an SSHFP, a TLSA, an MX with no preference). Stored and listed on the detail endpoint rather than dropped —… |
dns_captured_at | string | نہیں | When the source's zone was read. null means never attempted, which is NOT the same as attempted-and-the-panel-holds-no-zone; only the first is worth retrying. |
verified_at | string | نہیں | When the migrated site was last fetched over HTTP and compared with the source. null means the destination has never been looked at. |
verification_code | string | نہیں | A machine code the dashboard localises. Empty means the destination is serving the site as well as the source was. ⛔ The migration's own counters cannot answer this: they travel… |
destination_status | integer | نہیں | The HTTP status the migrated site returned, fetched at its origin address with a Host: header — before cutover the customer's domain still resolves to the OLD host, so asking… |
source_status | integer | نہیں | The HTTP status the source returned. ⭐ Reported beside destination_status because the interesting failure is the PAIR: a destination 200 against a source 500 means we faithfully… |
replaces_existing | boolean | نہیں | Whether this migration landed on a site that already held a website. Stamped when the job is created and never recomputed: after the apply step the site is occupied… |
safety_backup_state | string<not_needed, pending, taken, unsupported, failed> | نہیں | What became of the backup taken immediately before the apply step replaced the site. ⛔ Five values rather than a boolean: "there is no safety backup" is one rendered sentence… |
safety_backup_id | string | نہیں | The SiteBackup id, or "". ⛔ Still reported after the archive has been pruned by retention, so a rollback can say "that archive has expired" rather than looking like a… |
rolled_back_at | string | نہیں | When the customer put the site back. Set once — restoring the pre-migration archive over a site that is already the pre-migration archive can only lose work done since. |
rollback | MigrationRollback | نہیں | Whether this migration can be put back, and — when it cannot — why not. ⛔⛔ reason travels with available, always. Six different facts render as the same absent button… |
started_at | string | نہیں | — |
finished_at | string | نہیں | — |
created_at | string | ہاں | — |
وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے
401 · 403 · 404 · 422 · 429