hosting

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

توثيقِ شناخت

ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس 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`.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`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