hosting
GET /v1/sites/{siteId}/media-offload
Whether this site's media is offloaded to object storage, and how.
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 storage.view; 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 GET https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
-H "Authorization: Bearer zdk_live_…"Đã đă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
A site with no offload configured answers `200` with `configured: false`, **not** `404`. "This site does not offload its media" is an answer; a `404` would be indistinguishable from "no such site", which is what the screen would then have to show the customer. `plan` is returned in **both** states and carries the organisation's included storage, what it is using and what more costs. Media offload is an allowance in the plan plus metered overage, not a separate add-on, and the off state is where a customer needs that said. Requires `storage.view`.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
siteId (path) | Uuid | Có | Site ID (UUIDv7). |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
configured | boolean | Có | `false` when this site has no offload set up. The rest of the fields are then absent — except `plan`, which is present in both states on purpose. |
plan | MediaStorageTerms | Không | What this site's organisation gets included for media storage, what it is using, and what more would cost. Present on **every** media-offload response, including `configured: fa… |
id | string | Không | — |
site_id | string | Không | — |
bucket_id | string | Không | — |
status | string<awaiting_pairing, active, paused, revoked> | Không | — |
prefix | string | Không | The key prefix this site's objects live under. |
rewrite_urls | boolean | Không | Whether the plugin points media URLs at the bucket. Off means "upload a copy but keep serving locally", which is how a cautious customer migrates. |
delete_local | boolean | Không | Whether the plugin removes the local file after a confirmed upload. Defaults to off, and even when on the plugin refuses to delete after a partial upload. |
custom_domain | string | Không | The site's OWN media domain, as the customer typed it, or `""`. This is what belongs in the settings input box. See `public_base_url` for where media is actually served from — t… |
public_base_url | string | Không | Where this site's media is actually served from, after the site's own domain, the footprint rule and the bucket's shared hostname have been resolved. `""` means no URL is rewrit… |
needs_custom_domain | boolean | Không | `true` when this site is serving media locally only because it has no media domain of its own — a footprint-free site awaiting a CNAME. Distinguishes the one empty-`public_base_… |
accepts_uploads | boolean | Không | Whether the plugin may currently upload. Requires both an active offload and a usable bucket. |
paired | boolean | Không | Whether a plugin token has been issued. The token and its hash are never returned. |
plugin_version | string | Không | — |
last_seen_at | string | Không | When the plugin last called. `null` means it never has. |
objects_offloaded | integer | Không | What the plugin reports it has moved. A diagnostic for the screen, never an input to billing — storage is metered by measuring the bucket. |
bytes_offloaded | integer | Không | — |
created_at | string | Không | — |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 429