hosting

POST /v1/sites/{siteId}/backups/restore

Restore a site from one of its backups.

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í hosting.backup.manage; 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 POST https://api.zinndigital.com/v1/sites/{siteId}/backups/restore \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "backup_id": <Uuid> }'

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

Destructive. This overwrites the site's live database and files with the contents of the named backup. Its own path rather than a verb on the collection, so it can never be reached by varying the body of the endpoint that takes backups. The backup must belong to this site and must have completed successfully; anything else is 422. Requires hosting.backup.manage.

Parametry

NázevTypPožadovánoCo to je
siteId (path)UuidAnoSite ID (UUIDv7).
Idempotency-Key (header)stringNeClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Tělo požadavku

NázevTypPožadovánoCo to je
backup_idUuidAnoThe backup to restore. Always named explicitly — there is no "restore the latest", because a destructive operation must not depend on which row happens to sort first.

Odpověď

NázevTypPožadovánoCo to je
site_idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
backupsSiteBackup[]Ano
can_backupbooleanAnoFalse 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_progressbooleanAno
on_demand_backupsbooleanAnoAlways 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_reasonstringNeA 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_limitintegerAnoOn-demand backups allowed per rolling 24 hours, per site.
on_demand_usedintegerAnoOn-demand backups taken in the last 24 hours. Failed attempts are not counted — the customer got nothing from them.
on_demand_remainingintegerAnoHow many the customer may still take right now.
on_demand_next_atstringAnoWhen 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_backupsbooleanAnoThe plan's daily_backups entitlement — whether the nightly sweep selects this site.
retention_daysintegerAnoThe plan's backup_retention_days entitlement, clamped to the platform maximum.
offsite_enabledbooleanAnoWhether object storage is configured. False means every backup stays on the worker host it was taken on.
immutablebooleanAnoWhether 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_daysintegerAnoHow 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_atstringAnoWhen 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_reasonstringAnoA stable machine identifier saying why immutability is not currently provable — never_checked, no_rule, delete_succeeded, credential_missing, lock_api_unreachable,…
restore_drill_passedbooleanAnoWhether 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_atstringAnoWhen the last drill finished, whatever its outcome. Null when no drill has ever completed.
restore_drill_reasonstringAnoA stable machine identifier saying why restores are not currently proven — never_drilled, no_drill_site, no_recent_backup, canary_unavailable, restore_failed,…

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

401 · 403 · 404 · 422 · 429 · 503