hosting
DELETE /v1/sites/{siteId}/media-offload
Revoke the plugin's token and stop new uploads.
Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin storage.manage; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/media-offload \
-H "Authorization: Bearer zdk_live_…"Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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`.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
siteId (path) | Uuid | Ya | Site ID (UUIDv7). |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
configured | boolean | Ya | `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 | Tidak | — |
site_id | string | Tidak | — |
bucket_id | string | Tidak | — |
status | string<awaiting_pairing, active, paused, revoked> | Tidak | — |
prefix | string | Tidak | The key prefix this site's objects live under. |
rewrite_urls | boolean | Tidak | 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 | Tidak | 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 | Tidak | 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 | Tidak | 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 | Tidak | `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 | Tidak | Whether the plugin may currently upload. Requires both an active offload and a usable bucket. |
paired | boolean | Tidak | Whether a plugin token has been issued. The token and its hash are never returned. |
plugin_version | string | Tidak | — |
last_seen_at | string | Tidak | When the plugin last called. `null` means it never has. |
objects_offloaded | integer | Tidak | 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 | Tidak | — |
created_at | string | Tidak | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 429