hosting
POST /v1/sites/{siteId}/vendor-snapshots
Take a vendor restore point for a site.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie hosting.backup.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/vendor-snapshots \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "scope": <string<web, database, mailbox>> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
Asks the hosting platform to snapshot the website, one database or one mailbox. `202`, because the platform runs the job afterwards and a `200` would claim an instant we never observed. ⛔ **The response is the new state of the whole surface, never a bare acknowledgement.** The client writes it straight into its cache, so an empty body would leave the button un-flipped and the poll never started, with nothing failing anywhere. `item_id` is empty for the website, whose item the platform identifies for us, and is checked against the live listing rather than trusted. A scope the platform cannot back up, a package type that excludes the surface, or a job already running are all `422` with our wording. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `hosting.backup.manage`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
scope | string<web, database, mailbox> | Ja | What to snapshot. |
item_id | string | Nee | Which database or mailbox. Empty for the website, whose item the platform identifies for us. It is checked against the live listing rather than trusted, so an id a client compos… |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
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. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429 · 503