hosting

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

Revoke the plugin's token and stop new uploads.

Semua titik akhir hosting

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran storage.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

NamaJenisDiperlukanApakah ia
siteId (path)UuidYaSite ID (UUIDv7).

Respons

NamaJenisDiperlukanApakah ia
configuredbooleanYa`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`.
idstringTidak
site_idstringTidak
bucket_idstringTidak
statusstring<awaiting_pairing, active, paused, revoked>Tidak
prefixstringTidakThe key prefix this site's objects live under.
rewrite_urlsbooleanTidakWhether 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_localbooleanTidakWhether 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_domainstringTidakThe 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_urlstringTidakWhere 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_domainbooleanTidak`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_uploadsbooleanTidakWhether the plugin may currently upload. Requires both an active offload and a usable bucket.
pairedbooleanTidakWhether a plugin token has been issued. The token and its hash are never returned.
plugin_versionstringTidak
last_seen_atstringTidakWhen the plugin last called. `null` means it never has.
objects_offloadedintegerTidakWhat the plugin reports it has moved. A diagnostic for the screen, never an input to billing — storage is metered by measuring the bucket.
bytes_offloadedintegerTidak
created_atstringTidak

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429