hosting

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

Work out which control panel a host runs, from the hostname alone.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن hosting.import.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/migrations/discover \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "host": <string> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Takes a hostname and **no credential**, and answers which control panel the host is running, on which port, and what we would expect to be able to take off it. It exists because the step before it used to be a dropdown asking a prospect to choose "cPanel / WHM" or "DirectAdmin" and to know their own control-panel port — which the customer who is leaving a host they are unhappy with frequently cannot answer, and a form that cannot be filled in is a migration that is postponed for ever. It runs unauthenticated TCP connects and reads public sign-in pages. Five protocol fingerprints decide first (`cpsrvd` in a `Server:` header, `PLESKSESSID`, and so on — facts about software, not a list of hosting brands that would rot); a language model is asked to read the page **only** when that table is not confident, and its answer is weighted evidence that cannot outrank a protocol banner. `agent_used` says whether it was asked. `outcome` is three-valued and never a boolean: `identified`, `unidentified` (something answered and we cannot place it — a candidate for the managed migration) and `unreachable` (nothing answered at all — usually a typo or a firewall). Those have opposite remedies, so folding them would hand both populations the same wrong advice. `routes` lists every way in that was tried and whether it answered, with `checked` distinguishing "closed" from "we never got to try". Read it when a panel is firewalled: a host with 2083 closed and 22 open can still have its files, databases and mail moved. **Nothing we do installs anything on the source** — no migration plugin, no backup plugin, no agent — so a host that forbids those blocks none of it. ⛔ `POST` although it creates nothing and carries no secret: it knocks on a third party's administrative ports, which is an act rather than a lookup, and must not be repeated by a prefetch or a back button. A bad hostname or a dead host is an `outcome`, not an error. Requires `hosting.import.manage`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`siteId (path)`	`Uuid`	نعم	Site ID (UUIDv7).

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`host`	`string`	نعم	The server address the current host gave them, e.g. `server123.theirhost.com`. A hostname, not a web address — no scheme and no path. The customer's own domain works too when it…

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`outcome`	`string<pending, identified, unidentified, unreachable>`	نعم	`pending` while the discovery workflow is still probing — poll `getMigrationDiscovery` until it is one of the other three (D19865). ⛔ Three answers and never a boolean. `unident…
`host`	`string`	نعم	The hostname as it was normalised, which may differ from what was typed.
`source`	`string`	نعم	The best candidate's `MigrationSource`, or `""` when there is none.
`port`	`integer`	نعم	The login port for that source, which is not necessarily the port the evidence came from: a banner read from cPanel's plaintext 2082 reports 2083, because that is where the…
`confidence`	`integer`	نعم	—
`confident`	`boolean`	نعم	May the credential form be pre-filled from this?
`candidates`	`MigrationDiscoveryCandidate[]`	نعم	—
`expectations`	`string[]`	نعم	Machine codes for what to expect from the winning source — e.g. `ftp_files_only`. ⛔ Expectations, not a capability claim: the authoritative answer comes from the credentialed pr…
`routes`	`MigrationDiscoveryRoute[]`	نعم	Every way in that was tried. Read it when a panel is firewalled — a host with 2083 closed and 22 open can still have everything moved.
`proxy_fronted`	`boolean`	نعم	This address is a CDN in front of a website, not a hosting account — several different panels' login ports accepted a connection at once and none of them answered with its own n…
`refused`	`string`	نعم	A customer-readable reason the hostname was rejected before any packet went out — a private address, an unresolvable name. `""` otherwise.
`agent_used`	`boolean`	نعم	Whether a language model was asked to read the sign-in page. It is asked only when the deterministic table produced no confident panel.
`agent_unavailable`	`string`	نعم	Machine code when the model was asked and could not answer (`ai_unavailable`, `ai_timeout`, …). `""` when it was not asked or it answered. ⛔ The deterministic answer stands eith…
`discovery_id`	`string`	نعم	The recorded run, for support. `""` when the row could not be written — which never costs the customer their answer.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429 · 503

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