hosting
GET /v1/sites/{siteId}/migrations/discoveries/{discoveryId}
Poll a discovery until it has an answer.
Authentication
Send an API key as a bearer token. The key must carry the hosting.import.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/migrations/discoveries/{discoveryId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The row discoverMigrationSource created, as the workflow completes it. outcome is pending until the probe has run — a few seconds, up to about two minutes when the fingerprint table is not confident and a model is asked to read the sign-in page — and then identified, unidentified or unreachable. A workflow that could not finish leaves unreachable with the reason recorded; a row never stays pending for ever. Reads the row, never Temporal, so polling is cheap. Scoped to the site: another tenant's discovery id is a 404. Requires hosting.import.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
discoveryId (path) | string | Yes | The discovery_id a discoverMigrationSource call answered with. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
outcome | string<pending, identified, unidentified, unreachable> | Yes | 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.… |
host | string | Yes | The hostname as it was normalised, which may differ from what was typed. |
source | string | Yes | The best candidate's MigrationSource, or "" when there is none. |
port | integer | Yes | 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 | Yes | — |
confident | boolean | Yes | May the credential form be pre-filled from this? |
candidates | MigrationDiscoveryCandidate[] | Yes | — |
expectations | string[] | Yes | 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… |
routes | MigrationDiscoveryRoute[] | Yes | 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 | Yes | 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… |
refused | string | Yes | A customer-readable reason the hostname was rejected before any packet went out — a private address, an unresolvable name. "" otherwise. |
agent_used | boolean | Yes | 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 | Yes | 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 either… |
discovery_id | string | Yes | The recorded run, for support. "" when the row could not be written — which never costs the customer their answer. |
Errors this endpoint can return
401 · 403 · 404 · 429