hosting
PUT /v1/sites/{siteId}/media-offload
Turn media offload on for a site, or change how it behaves.
සත්යාපනය
බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. යතුරෙහි storage.manage අවසරය තිබිය යුතුය; එය නොමැති යතුරක් 404 ලෙස නොව 403 ලෙස ප්රතික්ෂේප කෙරේ.
මෙම අවසාන ලක්ෂ්යය සඳහා සංවිධාන හැඳුනුම්පතක් (organisation id) අවශ්ය නොවේ. ඔබගේ යතුර මඟින් එය අයත් වන සංවිධානය දැනටමත් හඳුනා ගන්නා අතර, ප්රතිචාරය ඒ වෙත සීමා වේ.
උත්සාහ කරන්න
<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්රතිස්ථාපනය කරන්න.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'පද්ධතියට පිවිස සිටිනවාද? ඔබගේ උපකරණ පුවරුවේ ඇති API කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී API වෙත ඉල්ලීම ක්රියාත්මක කරන බැවින් ඔබට සැබෑ ප්රතිචාරය දැකගත හැක. මෙම අග්රලක්ෂ්යය API කොන්සෝලය තුළ විවෘත කරන්න
විස්තර
Creates the offload configuration if it does not exist, provisioning storage for the organisation on first use — "turn on media offload" is what the customer wants, and a bucket is our word for part of how we do it. Moving an offload that is already live to a different bucket answers 422. The objects already written stay where they are, so the switch would leave the site serving half its media from a bucket the configuration no longer names, and nothing would report it because new uploads would keep succeeding. Requires storage.manage.
පරාමිතීන්
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
siteId (path) | Uuid | ඔව් | Site ID (UUIDv7). |
ඉල්ලුම් පත්ර ශරීරය
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
bucket_id | string | නැත | Which bucket to use. Omit to use the organisation's own, provisioning one on first use. Changing this on a live offload is refused. |
enabled | boolean | නැත | Pause or resume a paired site. Ignored before the plugin has paired. |
rewrite_urls | boolean | නැත | — |
delete_local | boolean | නැත | — |
prefix | string | නැත | — |
custom_domain | string | නැත | A media domain of the site's own, replacing the shared Zinn® hostname. Must be https:// and a bare domain with no path. Send "" to clear it. Required to turn on URL rewriting… |
පsspil
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
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 · 422 · 429