hosting
GET /v1/sites/{siteId}/media-offload
Whether this site's media is offloaded to object storage, and how.
Doğrulama
API açarını bearer token kimi göndərin. Açar storage.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
-H "Authorization: Bearer zdk_live_…"Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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`.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
siteId (path) | Uuid | Bəli | Site ID (UUIDv7). |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
configured | boolean | Bəli | `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 | Xeyr | 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 | Xeyr | — |
site_id | string | Xeyr | — |
bucket_id | string | Xeyr | — |
status | string<awaiting_pairing, active, paused, revoked> | Xeyr | — |
prefix | string | Xeyr | The key prefix this site's objects live under. |
rewrite_urls | boolean | Xeyr | 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 | Xeyr | 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 | Xeyr | 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 | Xeyr | 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 | Xeyr | `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 | Xeyr | Whether the plugin may currently upload. Requires both an active offload and a usable bucket. |
paired | boolean | Xeyr | Whether a plugin token has been issued. The token and its hash are never returned. |
plugin_version | string | Xeyr | — |
last_seen_at | string | Xeyr | When the plugin last called. `null` means it never has. |
objects_offloaded | integer | Xeyr | 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 | Xeyr | — |
created_at | string | Xeyr | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 429