hosting
POST /v1/sites/{siteId}/migrations/{migrationId}/cancel
Stop a running migration.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن hosting.import.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.
لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/migrations/{migrationId}/cancel \
-H "Authorization: Bearer zdk_live_…"هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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 reachabl… |
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:… |
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 recor… |
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 faithful… |
started_at | string | لا | — |
finished_at | string | لا | — |
created_at | string | نعم | — |
الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه
401 · 403 · 404 · 422 · 429