hosting

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

Restore a site from a vendor restore point.

Lahat ng hosting endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na hosting.backup.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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> }'

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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

Mga Parameter

PangalanUriKailanganAno ito
siteId (path)UuidOoSite ID (UUIDv7).

Katawan ng kahilingan

PangalanUriKailanganAno ito
scopestring<web, database, mailbox>OoWhat to restore.
timestampstringOoThe restore point's handle, exactly as `getSiteVendorSnapshots` reported it.
item_idstringHindiWhich database or mailbox. Empty for the website.
temp_mailboxbooleanHindiMailboxes 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…

Tugon

PangalanUriKailanganAno ito
availablebooleanOoWhether the site's hosting platform has a timeline surface at all. False is **our** gap, and nothing the customer can do changes it.
permittedbooleanOoWhether the vendor package type includes it. False is answered by an upgrade.
probooleanOoWhether the package carries the paid tier rather than the included one.
attachedbooleanOoWhether 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_upbooleanOoWhether `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_webbooleanOoWhether 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_progressbooleanOoWhether any snapshot or restore job is running. This is what a client polls on, and only while it is true.
webSiteVendorSnapshotItemOoThe website's timeline, or null when the platform holds none.
databasesSiteVendorSnapshotItem[]OoEach database's timeline.
mailboxesSiteVendorSnapshotItem[]OoEach mailbox's timeline.

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 422 · 429 · 503