hosting

POST /v1/sites/{siteId}/backups

Take an on-demand backup of a site.

Dhammaan hosting bixiyayaasha

Xaqiijinta aqoonsiga

U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda hosting.backup.manage; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.

Boggan ma qaato aqoonsiga ururka. Furahaagu wuxuu horay u aqoonsanayaa ururka uu ka tirsan yahay, jawaabtuna waxay ku kooban tahay halkaas.

Isku day

Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.

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

Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API

Faahfaahin

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`.

Cabiraha

MagacaNoocLoo baahan yahayMaxay tahay
siteId (path)UuidHaaSite ID (UUIDv7).
Idempotency-Key (header)stringMayaClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Jawaab

MagacaNoocLoo baahan yahayMaxay tahay
site_idUuidHaaUUIDv7 identifier — sortable by creation time (docs/02 §8).
backupsSiteBackup[]Haa
can_backupbooleanHaaFalse 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_progressbooleanHaa
on_demand_backupsbooleanHaaAlways 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_reasonstringMayaA 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_limitintegerHaaOn-demand backups allowed per rolling 24 hours, per site.
on_demand_usedintegerHaaOn-demand backups taken in the last 24 hours. Failed attempts are not counted — the customer got nothing from them.
on_demand_remainingintegerHaaHow many the customer may still take right now.
on_demand_next_atstringHaaWhen 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_backupsbooleanHaaThe plan's `daily_backups` entitlement — whether the nightly sweep selects this site.
retention_daysintegerHaaThe plan's `backup_retention_days` entitlement, clamped to the platform maximum.
offsite_enabledbooleanHaaWhether object storage is configured. False means every backup stays on the worker host it was taken on.
immutablebooleanHaaWhether 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_daysintegerHaaHow 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_atstringHaaWhen 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_reasonstringHaaA stable machine identifier saying why immutability is not currently provable — `never_checked`, `no_rule`, `delete_succeeded`, `credential_missing`, `canary_write_failed`, `ven…
restore_drill_passedbooleanHaaWhether 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_atstringHaaWhen the last drill finished, whatever its outcome. Null when no drill has ever completed.
restore_drill_reasonstringHaaA stable machine identifier saying why restores are not currently proven — `never_drilled`, `no_drill_site`, `no_recent_backup`, `canary_unavailable`, `restore_failed`, `fence_r…

Cilladaha ay bartaani soo celin karto

401 · 403 · 404 · 409 · 422 · 429 · 503