hosting

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

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте hosting.import.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`siteId (path)`	`Uuid`	Иә	Site ID (UUIDv7).

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`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 reachable…
`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 door…
`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 is…
`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…

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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…
`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