hosting
POST /v1/sites/{siteId}/vendor-snapshots/restore
Restore a site from a vendor restore point.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie hosting.backup.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
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> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
siteId (path) | Uuid | Tak | Site ID (UUIDv7). |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
scope | string<web, database, mailbox> | Tak | What to restore. |
timestamp | string | Tak | The restore point's handle, exactly as getSiteVendorSnapshots reported it. |
item_id | string | Nie | Which database or mailbox. Empty for the website. |
temp_mailbox | boolean | Nie | 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… |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
available | boolean | Tak | 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 | Tak | Whether the vendor package type includes it. False is answered by an upgrade. |
pro | boolean | Tak | Whether the package carries the paid tier rather than the included one. |
attached | boolean | Tak | 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 | Tak | 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 | Tak | 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 | Tak | Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true. |
web | SiteVendorSnapshotItem | Tak | The website's timeline, or null when the platform holds none. |
databases | SiteVendorSnapshotItem[] | Tak | Each database's timeline. |
mailboxes | SiteVendorSnapshotItem[] | Tak | Each mailbox's timeline. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422 · 429 · 503