hosting
POST /v1/sites/{siteId}/vendor-snapshots
Take a vendor restore point for a site.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) hosting.backup.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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>> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
siteId (path) | Uuid | Igen | Site ID (UUIDv7). |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
scope | string<web, database, mailbox> | Igen | What to snapshot. |
item_id | string | Nem | 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 composed… |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
available | boolean | Igen | 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 | Igen | Whether the vendor package type includes it. False is answered by an upgrade. |
pro | boolean | Igen | Whether the package carries the paid tier rather than the included one. |
attached | boolean | Igen | 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 | Igen | 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 | Igen | 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 | Igen | Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true. |
web | SiteVendorSnapshotItem | Igen | The website's timeline, or null when the platform holds none. |
databases | SiteVendorSnapshotItem[] | Igen | Each database's timeline. |
mailboxes | SiteVendorSnapshotItem[] | Igen | Each mailbox's timeline. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422 · 429 · 503