hosting
GET /v1/sites/{siteId}/vendor-snapshots
List a site's vendor restore points.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/vendor-snapshots \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
available | boolean | Oui | 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 | Oui | Whether the vendor package type includes it. False is answered by an upgrade. |
pro | boolean | Oui | Whether the package carries the paid tier rather than the included one. |
attached | boolean | Oui | 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 | Oui | 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 | Oui | 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… |
in_progress | boolean | Oui | Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true. |
web | SiteVendorSnapshotItem | Oui | The website's timeline, or null when the platform holds none. |
databases | SiteVendorSnapshotItem[] | Oui | Each database's timeline. |
mailboxes | SiteVendorSnapshotItem[] | Oui | Each mailbox's timeline. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429 · 503