hosting
POST /v1/sites/{siteId}/migrations/probe
Sign in to the old host and show what is there.
Authentication
Send an API key as a bearer token. The key must carry the hosting.import.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/migrations/probe \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "source": <MigrationSource>, "host": <string>, "username": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The migration form's preview: authenticates against the source and enumerates the estate **without creating a job**. Run while the customer is still on the screen, which is the whole design — a wrong password becomes a form error instead of a job that fails an hour later, and the customer confirms what is about to move before anything is committed. It is also where the mail precondition is discovered early enough to be fixable. Read `unavailable` before believing an empty list: it names what we could not look at, and "there is no mail here" and "this login cannot see mail" are opposite answers. Refusals arrive as 422 with a machine `code` per detail row (`source_credentials_rejected`, `source_unreachable`, `source_host_not_public`, `plesk_needs_admin_credentials`, `credential_required`), so the dashboard localises them rather than showing engine English. ⛔ `POST` although it creates nothing: the body carries a live credential for somebody else's server, and a `GET` would put it in a query string — browser history, proxy logs, access logs. Requires `hosting.import.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
source | MigrationSource | Yes | 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 | Yes | 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 | Yes | The login for the source panel or account. |
port | integer | No | `0` means the source driver's default for that panel. |
password | string | No | — |
private_key | string | No | An SSH private key in PEM form, for an `ssh` source. |
api_token | string | No | — |
include_mail | boolean | No | ⚖️ 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 | No | `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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
domains | string[] | Yes | — |
files | integer | Yes | How many files were found. A count, not the list — a 5,000-file estate is not a form field, and the per-item rows are written by the job. |
databases | MigrationSourceDatabase[] | Yes | — |
mailboxes | MigrationSourceMailbox[] | Yes | — |
total_bytes | integer | Yes | — |
truncated | boolean | Yes | True when the source stopped short of a complete listing. Reported, never swallowed. |
unavailable | object | Yes | ⭐ **The most important field here**: `capability -> machine code`, naming what we could not look at. An empty object means "we looked and there is nothing else", which is a diff… |
mailboxes_without_passwords | string[] | Yes | The addresses no usable password was supplied for. The form points at exactly these rows; a create with any of them present is refused with `mailbox_passwords_required`. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429