hosting

GET /v1/sites/{siteId}/migrations/{migrationId}

One migration's state and progress.

Minden hosting végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) sites.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/migrations/{migrationId} \
  -H "Authorization: Bearer zdk_live_…"

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

A pure database read, polled by the progress screen. Progress is per-kind counters rather than only a percentage, because "which step" is the useful answer when a customer asks why a migration is slow, and `items_failed` is reported separately from the `*_done` counts so a job that could not fetch part of the estate cannot report itself complete. Requires `sites.view`.

Paraméterek

NévTípusKötelezőMi ez
siteId (path)UuidIgenSite ID (UUIDv7).
migrationId (path)UuidIgenThe migration job's id (UUIDv7), as `listSiteMigrations` reports it. **Ours**, minted when the row was written — never anything the source host knows about.

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
sourceMigrationSourceIgenThe 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…
statusSiteMigrationStatusIgen`authenticating`, `inventorying` and `transferring` are separate states rather than one `running` because they fail for opposite reasons and the customer's next action differs:…
status_reasonstringNemA machine code the dashboard renders through its own catalogue — never an English sentence composed by the engine, which could be shown to none of the other 57 locales.
include_mailbooleanIgen
source_hoststringNemThe hostname the estate is being pulled from. Host only: no port, no username, and never a secret.
files_totalintegerIgen
files_doneintegerIgen
databases_totalintegerIgen
databases_doneintegerIgen
mailboxes_totalintegerIgen
mailboxes_doneintegerIgen
items_failedintegerIgen⛔ Counted separately from the `*_done` fields, never folded into them. "We could not get it" reported as "done" makes the completion report a lie.
bytes_transferredintegerIgen
warningsstring[]IgenMachine warning codes the dashboard localises.
mail_synced_atstringNemWhen the mail delta last ran. `null` and a timestamp are different states, and the cutover control reads this to tell them apart.
dns_records_capturedintegerNemHow many records were read off the source's zone and will be published on cutover. ⛔ Counted separately from `dns_records_unsupported`, never as one total: "we captured 14 recor…
dns_records_unsupportedintegerNemReal records the source holds that our DNS editor cannot express (an `SSHFP`, a `TLSA`, an `MX` with no preference). Stored and listed on the detail endpoint rather than dropped…
dns_captured_atstringNemWhen the source's zone was read. `null` means never attempted, which is NOT the same as attempted-and-the-panel-holds-no-zone; only the first is worth retrying.
verified_atstringNemWhen the migrated site was last fetched over HTTP and compared with the source. `null` means the destination has never been looked at.
verification_codestringNemA machine code the dashboard localises. Empty means the destination is serving the site as well as the source was. ⛔ The migration's own counters cannot answer this: they travel…
destination_statusintegerNemThe HTTP status the migrated site returned, fetched at its origin address with a `Host:` header — before cutover the customer's domain still resolves to the OLD host, so asking…
source_statusintegerNemThe HTTP status the source returned. ⭐ Reported beside `destination_status` because the interesting failure is the PAIR: a destination 200 against a source 500 means we faithful…
started_atstringNem
finished_atstringNem
created_atstringIgen
dns_recordsMigrationDnsRecord[]Igen
dns_planMigrationDnsPlanIgenThe **dry run**: exactly what the cutover will do to the zone, before it does it. Computed by the same function the cutover publishes from, so it cannot drift from what actually…
reportMigrationReportIgenWhat the customer is told about the migration, in their own language. `null` until the report step has run — which is a real state while files are still copying, and is **not**…

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429