hosting

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

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

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението storage.manage; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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, за да можете да видите действителния отговор. Отворете този крайpoint в 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 rewritin…

Отговор

Име	Тип	Задължително	Какво представлява
`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 `configured: fa…
`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 — t…
`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 rewrit…
`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 empty-`public_base_…
`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`	Не	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429

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