hosting
PUT /v1/sites/{siteId}/media-offload
Turn media offload on for a site, or change how it behaves.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation storage.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
bucket_id | string | Non | 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 | Non | Pause or resume a paired site. Ignored before the plugin has paired. |
rewrite_urls | boolean | Non | — |
delete_local | boolean | Non | — |
prefix | string | Non | — |
custom_domain | string | Non | 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… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
configured | boolean | Oui | 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 | Non | 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 | Non | — |
site_id | string | Non | — |
bucket_id | string | Non | — |
status | string<awaiting_pairing, active, paused, revoked> | Non | — |
prefix | string | Non | The key prefix this site's objects live under. |
rewrite_urls | boolean | Non | 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 | Non | 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 | Non | 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 | Non | 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 | Non | 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 | Non | Whether the plugin may currently upload. Requires both an active offload and a usable bucket. |
paired | boolean | Non | Whether a plugin token has been issued. The token and its hash are never returned. |
plugin_version | string | Non | — |
last_seen_at | string | Non | When the plugin last called. null means it never has. |
objects_offloaded | integer | Non | 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 | Non | — |
created_at | string | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429