hosting
DELETE /v1/sites/{siteId}/media-offload
Revoke the plugin's token and stop new uploads.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění storage.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | Uuid | Ano | Site ID (UUIDv7). |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
configured | boolean | Ano | 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 | Ne | 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 | Ne | — |
site_id | string | Ne | — |
bucket_id | string | Ne | — |
status | string<awaiting_pairing, active, paused, revoked> | Ne | — |
prefix | string | Ne | The key prefix this site's objects live under. |
rewrite_urls | boolean | Ne | 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 | Ne | 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 | Ne | 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 | Ne | 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 | Ne | 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 | Ne | Whether the plugin may currently upload. Requires both an active offload and a usable bucket. |
paired | boolean | Ne | Whether a plugin token has been issued. The token and its hash are never returned. |
plugin_version | string | Ne | — |
last_seen_at | string | Ne | When the plugin last called. null means it never has. |
objects_offloaded | integer | Ne | 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 | Ne | — |
created_at | string | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 429