hosting
POST /v1/sites/{siteId}/vendor-snapshots/restore
Restore a site from a vendor restore point.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز hosting.backup.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/vendor-snapshots/restore \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "scope": <string<web, database, mailbox>>, "timestamp": <string> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Rolls the website, one database or one mailbox back to a named restore point. 202 and the whole surface's new state, for the same reason takeSiteVendorSnapshot returns it: the platform performs the restore afterwards and the client polls on in_progress. ⛔ This is the destructive one, and its own path is part of how it is gated. It overwrites the customer's live files and database, so it is deliberately not a verb on the collection that takes backups — it must not be reachable by sending a slightly different body to the endpoint beside it. A restore always names its restore point, never "the latest": timestamp is one of the values getSiteVendorSnapshots returned, and the engine re-checks it against the live listing before anything is sent, so a value a client composed cannot reach the vendor. temp_mailbox applies to mailboxes only, where the platform restores into a temp- prefixed mailbox instead of overwriting the original; it is offered as a choice rather than assumed. The action is audit-logged after the platform accepts it, so the trail never claims a restore a refusal never started. 404 for a site with no vendor hosting package, or one that is not the caller's; 422 for a restore point that is no longer in the listing or a scope that cannot be restored. Requires hosting.backup.manage.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
siteId (path) | Uuid | بله | Site ID (UUIDv7). |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
scope | string<web, database, mailbox> | بله | What to restore. |
timestamp | string | بله | The restore point's handle, exactly as getSiteVendorSnapshots reported it. |
item_id | string | خیر | Which database or mailbox. Empty for the website. |
temp_mailbox | boolean | خیر | Mailboxes only. The platform restores into a temp- prefixed mailbox instead of overwriting the original, which is the safe default for mail — offered as a choice rather than… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
available | boolean | بله | Whether the site's hosting platform has a timeline surface at all. False is our gap, and nothing the customer can do changes it. |
permitted | boolean | بله | Whether the vendor package type includes it. False is answered by an upgrade. |
pro | boolean | بله | Whether the package carries the paid tier rather than the included one. |
attached | boolean | بله | Whether a Timeline Storage service is actually attached to the package. False is the third "no", and it is neither of the other two. |
can_back_up | boolean | بله | Whether takeSiteVendorSnapshot would be accepted right now. Read rather than recomputed from the three flags above, so a screen never offers a button the engine refuses. |
has_dead_web | boolean | بله | Whether the platform reports the website's timeline as broken. It is surfaced rather than hidden: a customer whose restore points stopped being taken needs to know before they… |
in_progress | boolean | بله | Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true. |
web | SiteVendorSnapshotItem | بله | The website's timeline, or null when the platform holds none. |
databases | SiteVendorSnapshotItem[] | بله | Each database's timeline. |
mailboxes | SiteVendorSnapshotItem[] | بله | Each mailbox's timeline. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 422 · 429 · 503