hosting

GET /v1/sites/{siteId}/vendor-snapshots

List a site's vendor restore points.

所有 hosting 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vendor-snapshots \
  -H "Authorization: Bearer zdk_live_…"

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 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)UuidSite ID (UUIDv7).

响应

名称类型必填内容简介
availablebooleanWhether the site's hosting platform has a timeline surface at all. False is **our** gap, and nothing the customer can do changes it.
permittedbooleanWhether the vendor package type includes it. False is answered by an upgrade.
probooleanWhether the package carries the paid tier rather than the included one.
attachedbooleanWhether 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_upbooleanWhether `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_webbooleanWhether 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_progressbooleanWhether any snapshot or restore job is running. This is what a client polls on, and only while it is true.
webSiteVendorSnapshotItemThe 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