hosting

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

One migration's state and progress.

Wszystkie punkty końcowe hosting

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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`.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).
migrationId (path)UuidTakThe migration job's id (UUIDv7), as `listSiteMigrations` reports it. **Ours**, minted when the row was written — never anything the source host knows about.

Odpowiedź

NazwaTypWymaganeCo to jest
idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
sourceMigrationSourceTakThe 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…
statusSiteMigrationStatusTak`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_reasonstringNieA 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_mailbooleanTak
source_hoststringNieThe hostname the estate is being pulled from. Host only: no port, no username, and never a secret.
files_totalintegerTak
files_doneintegerTak
databases_totalintegerTak
databases_doneintegerTak
mailboxes_totalintegerTak
mailboxes_doneintegerTak
items_failedintegerTak⛔ 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_transferredintegerTak
warningsstring[]TakMachine warning codes the dashboard localises.
mail_synced_atstringNieWhen the mail delta last ran. `null` and a timestamp are different states, and the cutover control reads this to tell them apart.
dns_records_capturedintegerNieHow 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_unsupportedintegerNieReal 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_atstringNieWhen 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_atstringNieWhen the migrated site was last fetched over HTTP and compared with the source. `null` means the destination has never been looked at.
verification_codestringNieA 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_statusintegerNieThe 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_statusintegerNieThe 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_atstringNie
finished_atstringNie
created_atstringTak
dns_recordsMigrationDnsRecord[]Tak
dns_planMigrationDnsPlanTakThe **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…
reportMigrationReportTakWhat 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**…

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429