hosting
GET /v1/sites/{siteId}/vendor-snapshots
List a site's vendor restore points.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vendor-snapshots \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
The website, database and mailbox restore points the hosting platform holds for this site. Until this resource existed, a plan chip reading *"Point-in-time backups you can restore yourself"* was served by an endpoint that refuses. ⛔ **Three different "no"s are reported separately and must not be collapsed**, because they need three different sentences and only one of them is answered by the customer doing anything: `available: false` is the site's platform having no timeline surface (our gap), `permitted: false` is the vendor package type excluding it (an upgrade answers this), and `attached: false` is no Timeline Storage service being attached to the package. `timestamp` on a restore point is the platform's own string and is the handle a restore sends back — it is **not** display text; `as_of` is what a date formatter reads, and is null when no exact instant was given. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `sites.view`.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
siteId (path) | Uuid | Да | Site ID (UUIDv7). |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
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