hosting
GET /v1/sites/{siteId}/media-offload
Whether this site's media is offloaded to object storage, and how.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს storage.view ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
-H "Authorization: Bearer zdk_live_…"შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში
დეტალები
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.
პარამეტრები
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
siteId (path) | Uuid | დიახ | Site ID (UUIDv7). |
პასუხი
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
configured | boolean | დიახ | 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 | არა | 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… |
id | string | არა | — |
site_id | string | არა | — |
bucket_id | string | არა | — |
status | string<awaiting_pairing, active, paused, revoked> | არა | — |
prefix | string | არა | The key prefix this site's objects live under. |
rewrite_urls | boolean | არა | 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 | არა | 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 | არა | 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 — the… |
public_base_url | string | არა | 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… |
needs_custom_domain | boolean | არა | 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… |
accepts_uploads | boolean | არა | Whether the plugin may currently upload. Requires both an active offload and a usable bucket. |
paired | boolean | არა | Whether a plugin token has been issued. The token and its hash are never returned. |
plugin_version | string | არა | — |
last_seen_at | string | არა | When the plugin last called. null means it never has. |
objects_offloaded | integer | არა | 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 | არა | — |
created_at | string | არა | — |
შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს
401 · 403 · 404 · 429