hosting
POST /v1/sites/{siteId}/backups
Take an on-demand backup of a site.
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 \
-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
Starts a durable backup workflow and returns immediately with the new in-flight state, never a bare acknowledgement. Gated on the on_demand_backups entitlement as well as the permission: a plan that does not include it gets PLAN_REQUIRED (422, an upgrade prompt), not a 403. A site with a backup already running returns 409. Requires hosting.backup.manage.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | Uuid | Ano | Site ID (UUIDv7). |
Idempotency-Key (header) | string | Ne | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
site_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
backups | SiteBackup[] | Ano | — |
can_backup | boolean | Ano | False 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_progress | boolean | Ano | — |
on_demand_backups | boolean | Ano | Always 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_reason | string | Ne | A 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_limit | integer | Ano | On-demand backups allowed per rolling 24 hours, per site. |
on_demand_used | integer | Ano | On-demand backups taken in the last 24 hours. Failed attempts are not counted — the customer got nothing from them. |
on_demand_remaining | integer | Ano | How many the customer may still take right now. |
on_demand_next_at | string | Ano | When 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_backups | boolean | Ano | The plan's daily_backups entitlement — whether the nightly sweep selects this site. |
retention_days | integer | Ano | The plan's backup_retention_days entitlement, clamped to the platform maximum. |
offsite_enabled | boolean | Ano | Whether object storage is configured. False means every backup stays on the worker host it was taken on. |
immutable | boolean | Ano | Whether 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_days | integer | Ano | How 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_at | string | Ano | When 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_reason | string | Ano | A stable machine identifier saying why immutability is not currently provable — never_checked, no_rule, delete_succeeded, credential_missing, lock_api_unreachable,… |
restore_drill_passed | boolean | Ano | Whether 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_at | string | Ano | When the last drill finished, whatever its outcome. Null when no drill has ever completed. |
restore_drill_reason | string | Ano | A 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 · 409 · 422 · 429 · 503