hosting
POST /v1/sites/{siteId}/backups
Take an on-demand backup of a site.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea hosting.backup.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/backups \
-H "Authorization: Bearer zdk_live_…"Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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`.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
siteId (path) | Uuid | Da | Site ID (UUIDv7). |
Idempotency-Key (header) | string | Nu | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
site_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
backups | SiteBackup[] | Da | — |
can_backup | boolean | Da | 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 | Da | — |
on_demand_backups | boolean | Da | 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 compa… |
unsupported_reason | string | Nu | 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 fro… |
on_demand_limit | integer | Da | On-demand backups allowed per rolling 24 hours, per site. |
on_demand_used | integer | Da | On-demand backups taken in the last 24 hours. Failed attempts are not counted — the customer got nothing from them. |
on_demand_remaining | integer | Da | How many the customer may still take right now. |
on_demand_next_at | string | Da | 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 | Da | The plan's `daily_backups` entitlement — whether the nightly sweep selects this site. |
retention_days | integer | Da | The plan's `backup_retention_days` entitlement, clamped to the platform maximum. |
offsite_enabled | boolean | Da | Whether object storage is configured. False means every backup stays on the worker host it was taken on. |
immutable | boolean | Da | 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 | Da | 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 | Da | 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 | Da | A stable machine identifier saying why immutability is not currently provable — `never_checked`, `no_rule`, `delete_succeeded`, `credential_missing`, `canary_write_failed`, `ven… |
restore_drill_passed | boolean | Da | 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 | Da | When the last drill finished, whatever its outcome. Null when no drill has ever completed. |
restore_drill_reason | string | Da | A stable machine identifier saying why restores are not currently proven — `never_drilled`, `no_drill_site`, `no_recent_backup`, `canary_unavailable`, `restore_failed`, `fence_r… |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 409 · 422 · 429 · 503