hosting

GET /v1/migrations/discoveries/{discoveryId}

Poll a discovery started without a site.

All hosting endpoints

All developer docs

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/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

Answers from the row the workflow completes. outcome is pending until then and one of the three answers afterwards; a workflow that could not finish leaves unreachable with its reason, never pending for ever. Scoped to the caller's own organisations — another tenant's discovery id is a 404, not their row. Requires hosting.import.manage.

Parameters

NameTypeRequiredWhat it is
discoveryId (path)UuidYes

Response

NameTypeRequiredWhat it is
outcomestring<pending, identified, unidentified, unreachable>Yespending while the discovery workflow is still probing — poll getMigrationDiscovery until it is one of the other three (D19865). ⛔ Three answers and never a boolean.…
hoststringYesThe hostname as it was normalised, which may differ from what was typed.
sourcestringYesThe best candidate's MigrationSource, or "" when there is none.
portintegerYesThe 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…
confidenceintegerYes
confidentbooleanYesMay the credential form be pre-filled from this?
candidatesMigrationDiscoveryCandidate[]Yes
expectationsstring[]YesMachine 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…
routesMigrationDiscoveryRoute[]YesEvery 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_frontedbooleanYesThis 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…
refusedstringYesA customer-readable reason the hostname was rejected before any packet went out — a private address, an unresolvable name. "" otherwise.
agent_usedbooleanYesWhether a language model was asked to read the sign-in page. It is asked only when the deterministic table produced no confident panel.
agent_unavailablestringYesMachine 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_idstringYesThe 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