hosting
POST /v1/sites/{siteId}/migrations
Migrate a site in from another host.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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