hosting
GET /v1/sites/{siteId}/vendor-snapshots
List a site's vendor restore points.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vendor-snapshots \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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`.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
available | boolean | Ja | 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 | Ja | Whether the vendor package type includes it. False is answered by an upgrade. |
pro | boolean | Ja | Whether the package carries the paid tier rather than the included one. |
attached | boolean | Ja | 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 | Ja | 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 | Ja | 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 | Ja | Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true. |
web | SiteVendorSnapshotItem | Ja | The website's timeline, or null when the platform holds none. |
databases | SiteVendorSnapshotItem[] | Ja | Each database's timeline. |
mailboxes | SiteVendorSnapshotItem[] | Ja | Each mailbox's timeline. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422 · 429 · 503