hosting
POST /v1/sites/{siteId}/vendor-snapshots
Take a vendor restore point for a site.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Kalit hosting.backup.manage ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.
Bu yakuniy nuqta hech qanday tashkilot identifikatorini qabul qilmaydi. Sizning kalitingiz unga tegishli tashkilotni allaqachon aniqlaydi va javob shunga qarab cheklanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
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>> }'Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
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`.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
siteId (path) | Uuid | Ha | Site ID (UUIDv7). |
Soʻrov tanasi
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
scope | string<web, database, mailbox> | Ha | What to snapshot. |
item_id | string | Yo'q | 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… |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
available | boolean | Ha | 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 | Ha | Whether the vendor package type includes it. False is answered by an upgrade. |
pro | boolean | Ha | Whether the package carries the paid tier rather than the included one. |
attached | boolean | Ha | 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 | Ha | 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 | Ha | 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 | Ha | Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true. |
web | SiteVendorSnapshotItem | Ha | The website's timeline, or null when the platform holds none. |
databases | SiteVendorSnapshotItem[] | Ha | Each database's timeline. |
mailboxes | SiteVendorSnapshotItem[] | Ha | Each mailbox's timeline. |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 422 · 429 · 503