hosting
POST /v1/sites/{siteId}/vendor-snapshots
Take a vendor restore point for a site.
Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na hosting.backup.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong 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>> }'Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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`.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
siteId (path) | Uuid | Oo | Site ID (UUIDv7). |
Katawan ng kahilingan
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
scope | string<web, database, mailbox> | Oo | What to snapshot. |
item_id | string | Hindi | 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… |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
available | boolean | Oo | 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 | Oo | Whether the vendor package type includes it. False is answered by an upgrade. |
pro | boolean | Oo | Whether the package carries the paid tier rather than the included one. |
attached | boolean | Oo | 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 | Oo | 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 | Oo | 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 | Oo | Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true. |
web | SiteVendorSnapshotItem | Oo | The website's timeline, or null when the platform holds none. |
databases | SiteVendorSnapshotItem[] | Oo | Each database's timeline. |
mailboxes | SiteVendorSnapshotItem[] | Oo | Each mailbox's timeline. |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 422 · 429 · 503