hosting

POST /v1/sites/{siteId}/backups/transfer-in

Move an externally hosted site onto Zinn® hosting from a backup we hold.

Wszystkie punkty końcowe hosting

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie hosting.backup.manage; 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 POST https://api.zinndigital.com/v1/sites/{siteId}/backups/transfer-in \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "backup_id": <Uuid>, "source_site_id": <Uuid> }'

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

Destructive. Restores a backup taken from a site hosted somewhere else onto siteId, overwriting that site's live database and files. This is what makes an external-site backup subscription a migration path: because we already hold the archive, moving onto our hosting is a restore rather than a migration. Both sites must belong to the same organisation, source_site_id must be a site we do not host, siteId must be an active site we do, and the backup must be a completed full backup. Anything else is 422. Requires hosting.backup.manage on the destination. ⭐ Nothing is sent to the origin host: it is not contacted, nothing there is deleted, and its backup connection keeps running. Disconnecting it is a separate, customer-initiated act, so the original stays a working fallback until the customer is happy with the copy.

Parametry

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).
Idempotency-Key (header)stringNieClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Treść żądania

NazwaTypWymaganeCo to jest
backup_idUuidTakThe backup to land on this site. It must belong to source_site_id and must have completed successfully.
source_site_idUuidTakThe externally hosted site the backup was taken from. Named explicitly rather than derived from backup_id, so a mistyped backup id cannot silently move a different site onto…

Odpowiedź

NazwaTypWymaganeCo to jest
site_idUuidTakUUIDv7 identifier — sortable by creation time (docs/02 §8).
backupsSiteBackup[]Tak
can_backupbooleanTakFalse while a backup is in flight, when this site's hosting platform cannot take one at all, or when the site's on-demand allowance for the last 24 hours is spent.
in_progressbooleanTak
on_demand_backupsbooleanTakAlways true. On-demand backups are included on every plan (owner ruling 2026-08-10); what bounds them is on_demand_limit per rolling 24 hours, not the plan. Retained for…
unsupported_reasonstringNieA stable machine identifier saying why this site's hosting platform cannot be backed up at all, or empty when it can. The client renders it as a localised sentence. Distinct from…
on_demand_limitintegerTakOn-demand backups allowed per rolling 24 hours, per site.
on_demand_usedintegerTakOn-demand backups taken in the last 24 hours. Failed attempts are not counted — the customer got nothing from them.
on_demand_remainingintegerTakHow many the customer may still take right now.
on_demand_next_atstringTakWhen the next on-demand slot opens, as the oldest counted backup ages out of the rolling window. Null whenever on_demand_remaining is above zero.
daily_backupsbooleanTakThe plan's daily_backups entitlement — whether the nightly sweep selects this site.
retention_daysintegerTakThe plan's backup_retention_days entitlement, clamped to the platform maximum.
offsite_enabledbooleanTakWhether object storage is configured. False means every backup stays on the worker host it was taken on.
immutablebooleanTakWhether backup immutability is enforced and proven recently. True only when the platform's last reconciliation actually attempted to delete a canary object under the backup…
immutable_daysintegerTakHow many days a written backup cannot be altered or deleted by anyone — us, a compromised site, or a stolen token. 30 by owner ruling (2026-08-12), matching sold retention; 0
immutability_verified_atstringTakWhen a delete was last actually attempted against the protected prefix and refused. ⛔ Not when the configuration was last read, and not when the reconciler last ran: a run that…
immutability_reasonstringTakA stable machine identifier saying why immutability is not currently provable — never_checked, no_rule, delete_succeeded, credential_missing, lock_api_unreachable,…
restore_drill_passedbooleanTakWhether the platform's weekly restore drill last passed, and recently enough to still mean something. The drill restores a real stored backup onto a platform-owned site and…
restore_drill_atstringTakWhen the last drill finished, whatever its outcome. Null when no drill has ever completed.
restore_drill_reasonstringTakA stable machine identifier saying why restores are not currently proven — never_drilled, no_drill_site, no_recent_backup, canary_unavailable, restore_failed,…

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

401 · 403 · 404 · 422 · 429 · 503