hosting

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

Restore a site from a vendor restore point.

Все эндпоинты hosting

Аутентификация

Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение 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).

Тело запроса

ИмяТипОбязательноЧто это
scopestring<web, database, mailbox>ДаWhat to restore.
timestampstringДаThe restore point's handle, exactly as `getSiteVendorSnapshots` reported it.
item_idstringНетWhich database or mailbox. Empty for the website.
temp_mailboxbooleanНет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…

Ответ

ИмяТипОбязательноЧто это
availablebooleanДаWhether the site's hosting platform has a timeline surface at all. False is **our** gap, and nothing the customer can do changes it.
permittedbooleanДаWhether the vendor package type includes it. False is answered by an upgrade.
probooleanДаWhether the package carries the paid tier rather than the included one.
attachedbooleanДа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_upbooleanДа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_webbooleanДа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_progressbooleanДаWhether any snapshot or restore job is running. This is what a client polls on, and only while it is true.
webSiteVendorSnapshotItemДаThe website's timeline, or null when the platform holds none.
databasesSiteVendorSnapshotItem[]ДаEach database's timeline.
mailboxesSiteVendorSnapshotItem[]ДаEach mailbox's timeline.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422 · 429 · 503