hosting
POST /v1/sites/{siteId}/backups
Take an on-demand backup of a site.
அங்கீகாரம்
பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். அந்த விசை hosting.backup.manage அனுமதியைக் கொண்டிருக்க வேண்டும்; அது இல்லாத விசை 404 அல்ல, 403 குறியீட்டுடன் மறுக்கப்படும்.
இந்த எண்ட்பாயிண்டிற்கு எந்த அமைப்பு ஐடியும் (organisation id) தேவையில்லை. உங்கள் விசை (key) அது எந்த அமைப்புக்குரியது என்பதை ஏற்கனவே அடையாளம் காட்டுகிறது, மேலும் பதிலானது அதற்கேற்ப வரம்பிடப்பட்டுள்ளது.
முயன்று பார்
கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/backups \
-H "Authorization: Bearer zdk_live_…"உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்
விவரங்கள்
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`.
அளவுருக்கள்
| பெயர் | வகை | தேவைப்படுகிறது | அது என்ன |
|---|---|---|---|
siteId (path) | Uuid | ஆம் | Site ID (UUIDv7). |
Idempotency-Key (header) | string | இல்லை | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
பதில்
| பெயர் | வகை | தேவைப்படுகிறது | அது என்ன |
|---|---|---|---|
site_id | Uuid | ஆம் | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
backups | SiteBackup[] | ஆம் | — |
can_backup | boolean | ஆம் | 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 | ஆம் | — |
on_demand_backups | boolean | ஆம் | 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 | இல்லை | 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 | ஆம் | On-demand backups allowed per rolling 24 hours, per site. |
on_demand_used | integer | ஆம் | On-demand backups taken in the last 24 hours. Failed attempts are not counted — the customer got nothing from them. |
on_demand_remaining | integer | ஆம் | How many the customer may still take right now. |
on_demand_next_at | string | ஆம் | 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 | ஆம் | The plan's `daily_backups` entitlement — whether the nightly sweep selects this site. |
retention_days | integer | ஆம் | The plan's `backup_retention_days` entitlement, clamped to the platform maximum. |
offsite_enabled | boolean | ஆம் | Whether object storage is configured. False means every backup stays on the worker host it was taken on. |
immutable | boolean | ஆம் | 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 | ஆம் | 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 | ஆம் | 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 | ஆம் | 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 | ஆம் | 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 | ஆம் | When the last drill finished, whatever its outcome. Null when no drill has ever completed. |
restore_drill_reason | string | ஆம் | 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… |
இந்த எண்ட்ஸ்பாயிண்ட் திரும்ப அனுப்பக்கூடிய பிழைகள்
401 · 403 · 404 · 409 · 422 · 429 · 503