hosting
DELETE /v1/sites/{siteId}/media-offload
Revoke the plugin's token and stop new uploads.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão storage.manage; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
Revokes the WordPress plugin's token so the site can no longer upload. The configuration itself is **kept**, and that is deliberate: media already offloaded is addressed by URL inside the site's published posts, so discarding the bucket and prefix would break every one of those images. The customer asked to stop uploading, not to blank their archive. Requires `storage.manage`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
siteId (path) | Uuid | Sim | Site ID (UUIDv7). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
configured | boolean | Sim | `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 | Não | — |
site_id | string | Não | — |
bucket_id | string | Não | — |
status | string<awaiting_pairing, active, paused, revoked> | Não | — |
prefix | string | Não | The key prefix this site's objects live under. |
rewrite_urls | boolean | Não | 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 | Não | 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 | Não | 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 | Não | 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 | Não | `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 | Não | Whether the plugin may currently upload. Requires both an active offload and a usable bucket. |
paired | boolean | Não | Whether a plugin token has been issued. The token and its hash are never returned. |
plugin_version | string | Não | — |
last_seen_at | string | Não | When the plugin last called. `null` means it never has. |
objects_offloaded | integer | Não | 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 | Não | — |
created_at | string | Não | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429