hosting

PUT `/v1/sites/{siteId}/media-offload`

Turn media offload on for a site, or change how it behaves.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea storage.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul 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 '{  }'

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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`.

Parametri

Nume	Tip	Obligatoriu	Ce este
`siteId (path)`	`Uuid`	Da	Site ID (UUIDv7).

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`bucket_id`	`string`	Nu	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`	Nu	Pause or resume a paired site. Ignored before the plugin has paired.
`rewrite_urls`	`boolean`	Nu	—
`delete_local`	`boolean`	Nu	—
`prefix`	`string`	Nu	—
`custom_domain`	`string`	Nu	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 rewritin…

Răspuns

Nume	Tip	Obligatoriu	Ce este
`configured`	`boolean`	Da	`false` when this site has no offload set up. The rest of the fields are then absent. A site with no offload is a `200`, never a `404`.
`id`	`string`	Nu	—
`site_id`	`string`	Nu	—
`bucket_id`	`string`	Nu	—
`status`	`string<awaiting_pairing, active, paused, revoked>`	Nu	—
`prefix`	`string`	Nu	The key prefix this site's objects live under.
`rewrite_urls`	`boolean`	Nu	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`	Nu	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`	Nu	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`	Nu	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`	Nu	`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`	Nu	Whether the plugin may currently upload. Requires both an active offload and a usable bucket.
`paired`	`boolean`	Nu	Whether a plugin token has been issued. The token and its hash are never returned.
`plugin_version`	`string`	Nu	—
`last_seen_at`	`string`	Nu	When the plugin last called. `null` means it never has.
`objects_offloaded`	`integer`	Nu	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`	Nu	—
`created_at`	`string`	Nu	—

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422 · 429

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