hosting
POST /v1/sites/{siteId}/migrations
Migrate a site in from another host.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن hosting.import.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.
لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/migrations \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "source": <MigrationSource>, "host": <string>, "username": <string>, "ownership_attested": <boolean> }'هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API
التفاصيل
Probes the source, records the job and its per-item rows, then starts a durable workflow that resumes rather than restarts — a 5,000-file or 40-mailbox job survives a worker being replaced, which matters because a restart would mean a second full read of a stranger's live server. Returns `202` with the **new job state**, never a bare acknowledgement. Refused up front, while the customer still has their old account, if the source cannot give us the mail they asked for (`source_cannot_migrate_mail`) or if any mailbox has no password (`mailbox_passwords_required`, with the count in the detail rows) — a migration that moves a website and silently loses the mailboxes is worse for the customer than no migration at all. Other refusals are 422 with a machine `code`; a site that already has a migration running is 409; a site mid-move between our own fleet workers is also 409. If the workflow service or the secret store is unavailable the answer is 503 and **no job is written** — an acceptance we cannot honour would leave the customer watching a progress bar for ever. Requires `hosting.import.manage`.
المعلمات
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
siteId (path) | Uuid | نعم | Site ID (UUIDv7). |
Idempotency-Key (header) | string | لا | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
جسم الطلب
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
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… |
host | string | نعم | The server's public hostname, e.g. `server123.yourhost.com`. Must resolve to a public address — a private or link-local target is refused with `source_host_not_public` at the do… |
username | string | نعم | The login for the source panel or account. |
port | integer | لا | `0` means the source driver's default for that panel. |
password | string | لا | — |
private_key | string | لا | An SSH private key in PEM form, for an `ssh` source. |
api_token | string | لا | — |
include_mail | boolean | لا | ⚖️ Defaults to true, and a source that cannot deliver mailboxes is **refused rather than silently migrated without them** — a migration that moves a website and loses the mail i… |
mailbox_passwords | object | لا | `address -> password`, for every mailbox being moved. Required up front rather than discovered mid-sync: most panels will not hand over a mailbox without its own password, and f… |
ownership_attested | boolean | نعم | ⚠️ The customer's assertion that this estate is theirs to move, recorded because it cannot be reconstructed afterwards. Required — the job is refused without it — but it is **no… |
الاستجابة
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
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 · 409 · 422 · 429 · 503