hosting
POST /v1/sites/{siteId}/vendor-snapshots
Take a vendor restore point for a site.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền hosting.backup.manage; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
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>> }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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`.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
siteId (path) | Uuid | Có | Site ID (UUIDv7). |
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
scope | string<web, database, mailbox> | Có | What to snapshot. |
item_id | string | Không | 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… |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
available | boolean | Có | 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 | Có | Whether the vendor package type includes it. False is answered by an upgrade. |
pro | boolean | Có | Whether the package carries the paid tier rather than the included one. |
attached | boolean | Có | 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 | Có | 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 | Có | 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 | Có | Whether any snapshot or restore job is running. This is what a client polls on, and only while it is true. |
web | SiteVendorSnapshotItem | Có | The website's timeline, or null when the platform holds none. |
databases | SiteVendorSnapshotItem[] | Có | Each database's timeline. |
mailboxes | SiteVendorSnapshotItem[] | Có | Each mailbox's timeline. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 422 · 429 · 503