hosting
GET /v1/sites/{siteId}/vendor-snapshots
List a site's vendor restore points.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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) | 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