hosting

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

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar hosting.import.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`siteId (path)`	`Uuid`	Evet	Site ID (UUIDv7).

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`source`	`MigrationSource`	Evet	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`	Evet	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`	Evet	The login for the source panel or account.
`port`	`integer`	Hayır	`0` means the source driver's default for that panel.
`password`	`string`	Hayır	—
`private_key`	`string`	Hayır	An SSH private key in PEM form, for an `ssh` source.
`api_token`	`string`	Hayır	—
`include_mail`	`boolean`	Hayır	⚖️ 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`	Hayır	`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…

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`domains`	`string[]`	Evet	—
`files`	`integer`	Evet	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[]`	Evet	—
`mailboxes`	`MigrationSourceMailbox[]`	Evet	—
`total_bytes`	`integer`	Evet	—
`truncated`	`boolean`	Evet	True when the source stopped short of a complete listing. Reported, never swallowed.
`unavailable`	`object`	Evet	⭐ 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[]`	Evet	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`.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422 · 429

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