hosting

POST `/v1/sites/{siteId}/vendor-snapshots/restore`

Restore a site from a vendor restore point.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास hosting.backup.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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 a…

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`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 n…
`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

POST /v1/sites/{siteId}/vendor-snapshots/restore