hosting

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

Revoke the plugin's token and stop new uploads.

Wszystkie punkty końcowe hosting

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie storage.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
  -H "Authorization: Bearer zdk_live_…"

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

NazwaTypWymaganeCo to jest
siteId (path)UuidTakSite ID (UUIDv7).

Odpowiedź

NazwaTypWymaganeCo to jest
configuredbooleanTak`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`.
idstringNie
site_idstringNie
bucket_idstringNie
statusstring<awaiting_pairing, active, paused, revoked>Nie
prefixstringNieThe key prefix this site's objects live under.
rewrite_urlsbooleanNieWhether 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_localbooleanNieWhether 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_domainstringNieThe 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_urlstringNieWhere 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_domainbooleanNie`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_uploadsbooleanNieWhether the plugin may currently upload. Requires both an active offload and a usable bucket.
pairedbooleanNieWhether a plugin token has been issued. The token and its hash are never returned.
plugin_versionstringNie
last_seen_atstringNieWhen the plugin last called. `null` means it never has.
objects_offloadedintegerNieWhat the plugin reports it has moved. A diagnostic for the screen, never an input to billing — storage is metered by measuring the bucket.
bytes_offloadedintegerNie
created_atstringNie

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 429