hosting

POST `/v1/sites/{siteId}/migrations/probe`

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה hosting.import.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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> }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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`.

פרמטרים

שם	סוג	נדרש	מה זה
`siteId (path)`	`Uuid`	כן	Site ID (UUIDv7).

גוף הבקשה

שם	סוג	נדרש	מה זה
`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…

תשובה

שם	סוג	נדרש	מה זה
`domains`	`string[]`	כן	—
`files`	`integer`	כן	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[]`	כן	—
`mailboxes`	`MigrationSourceMailbox[]`	כן	—
`total_bytes`	`integer`	כן	—
`truncated`	`boolean`	כן	True when the source stopped short of a complete listing. Reported, never swallowed.
`unavailable`	`object`	כן	⭐ 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[]`	כן	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`.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429

POST /v1/sites/{siteId}/migrations/probe