hosting

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

One migration's state and progress.

Všechny koncové body hosting

Všechny dokumenty pro vývojáře

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

NázevTypPožadovánoCo to je
siteId (path)UuidAnoSite ID (UUIDv7).
migrationId (path)UuidAnoThe migration job's id (UUIDv7), as listSiteMigrations reports it. Ours, minted when the row was written — never anything the source host knows about.

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
sourceMigrationSourceAnoThe 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 reachable…
statusSiteMigrationStatusAnoauthenticating, inventorying and transferring are separate states rather than one running because they fail for opposite reasons and the customer's next action differs: a…
status_reasonstringNeA 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_mailbooleanAno
source_hoststringNeThe hostname the estate is being pulled from. Host only: no port, no username, and never a secret.
files_totalintegerAno
files_doneintegerAno
databases_totalintegerAno
databases_doneintegerAno
mailboxes_totalintegerAno
mailboxes_doneintegerAno
items_failedintegerAno⛔ 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_transferredintegerAno
warningsstring[]AnoMachine warning codes the dashboard localises.
mail_synced_atstringNeWhen the mail delta last ran. null and a timestamp are different states, and the cutover control reads this to tell them apart.
dns_records_capturedintegerNeHow 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…
dns_records_unsupportedintegerNeReal 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_atstringNeWhen 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_atstringNeWhen the migrated site was last fetched over HTTP and compared with the source. null means the destination has never been looked at.
verification_codestringNeA 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_statusintegerNeThe 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_statusintegerNeThe 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 faithfully…
replaces_existingbooleanNeWhether this migration landed on a site that already held a website. Stamped when the job is created and never recomputed: after the apply step the site is occupied…
safety_backup_statestring<not_needed, pending, taken, unsupported, failed>NeWhat became of the backup taken immediately before the apply step replaced the site. ⛔ Five values rather than a boolean: "there is no safety backup" is one rendered sentence…
safety_backup_idstringNeThe SiteBackup id, or "". ⛔ Still reported after the archive has been pruned by retention, so a rollback can say "that archive has expired" rather than looking like a…
rolled_back_atstringNeWhen the customer put the site back. Set once — restoring the pre-migration archive over a site that is already the pre-migration archive can only lose work done since.
rollbackMigrationRollbackNeWhether this migration can be put back, and — when it cannot — why not. ⛔⛔ reason travels with available, always. Six different facts render as the same absent button…
started_atstringNe
finished_atstringNe
created_atstringAno
dns_recordsMigrationDnsRecord[]Ano
dns_planMigrationDnsPlanAnoThe 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…
reportMigrationReportAnoWhat 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

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429