hosting
POST /v1/sites/{siteId}/migrations
Migrate a site in from another host.
සත්යාපනය
බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. යතුරෙහි hosting.import.manage අවසරය තිබිය යුතුය; එය නොමැති යතුරක් 404 ලෙස නොව 403 ලෙස ප්රතික්ෂේප කෙරේ.
මෙම අවසාන ලක්ෂ්යය සඳහා සංවිධාන හැඳුනුම්පතක් (organisation id) අවශ්ය නොවේ. ඔබගේ යතුර මඟින් එය අයත් වන සංවිධානය දැනටමත් හඳුනා ගන්නා අතර, ප්රතිචාරය ඒ වෙත සීමා වේ.
උත්සාහ කරන්න
<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්රතිස්ථාපනය කරන්න.
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… |
පsspil
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
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