hosting

GET /v1/sites/{siteId}/media-offload

Whether this site's media is offloaded to object storage, and how.

ចំណុចបញ្ចប់ hosting ទាំងអស់

ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ

បញ្ជូនសោ API ជា bearer token។ សោនេះត្រូវតែមានសិទ្ធិ storage.view។ សោដែលគ្មានសិទ្ធិនេះនឹងត្រូវបដិសេធដោយកូដ 403 មិនមែន 404 ទេ។

ចំនុចបញ្ចប់នេះមិនត្រូវការលេខសម្គាល់ស្ថាប័នទេ។ ពស័្ដកូនរបស់អ្នករួចហើយកំណត់អត្តសញ្ញាណស្ថាប័នដែលវាជាកម្មសិទ្ធិ ហើយការឆ្លើយតបគឺត្រូវបានកំណត់វិសាលភាពទៅតាមនោះ។

សាកល្បង

ជំនួសអ្វីមួយនៅក្នុងសញ្ញាពងក្រពើ < > ដោយប្រើតម្លៃផ្ទាល់ខ្លួនរបស់អ្នក ហើយជំនួសកន្លែងរក្សាទុកសោដោយប្រើសោចេញពីផ្ទាំងគ្រប់គ្រងរបស់អ្នក។

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
  -H "Authorization: Bearer zdk_live_…"

បានចូលគណនីរួចហើយមែនទេ? កុងសូល API ក្នុងផ្ទាំងគ្រប់គ្រងរបស់អ្នក បំពេញលេខសម្គាល់ស្ថាប័នពិតប្រាកដរបស់អ្នក និងសោផ្ទាល់ខ្លួនរបស់អ្នក ហើយដំណើរការសំណើទល់នឹង API ផ្ទាល់ ដូច្នេះអ្នកអាចមើលឃើញការឆ្លើយតបពិតប្រាកដ។ បើកចំណុចបញ្ចប់នេះក្នុងកុងសូល 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).

ផ្អាកដំណើរការ

ឈ្មោះប្រភេទតម្រូវការតើវាជាអ្វី
configuredbooleanបាទ/ចាស`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.
planMediaStorageTermsទេ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…
idstringទេ
site_idstringទេ
bucket_idstringទេ
statusstring<awaiting_pairing, active, paused, revoked>ទេ
prefixstringទេThe key prefix this site's objects live under.
rewrite_urlsbooleanទេ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_localbooleanទេ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_domainstringទេ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_urlstringទេ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_domainbooleanទេ`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_uploadsbooleanទេWhether the plugin may currently upload. Requires both an active offload and a usable bucket.
pairedbooleanទេWhether a plugin token has been issued. The token and its hash are never returned.
plugin_versionstringទេ
last_seen_atstringទេWhen the plugin last called. `null` means it never has.
objects_offloadedintegerទេ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_offloadedintegerទេ
created_atstringទេ

កំហុសដែលចំណុចបញ្ចប់នេះអាចបង្វិលត្រឡប់មកវិញ

401 · 403 · 404 · 429