hosting

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

Revoke the plugin's token and stop new uploads.

Բոլոր hosting վերջնակետերը

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա storage.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

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`.

Պարամետրեր

ԱնունՏեսակՊահանջվում էԻնչ է դա
siteId (path)UuidԱյոSite ID (UUIDv7).

Պատասխան

ԱնունՏեսակՊահանջվում էԻնչ է դա
configuredbooleanԱյո`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`.
idstringՈչ
site_idstringՈչ
bucket_idstringՈչ
statusstring<awaiting_pairing, active, paused, revoked>Ոչ
prefixstringՈչThe key prefix this site's objects live under.
rewrite_urlsbooleanՈչ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_localbooleanՈչ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_domainstringՈչ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_urlstringՈչ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_domainbooleanՈչ`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_uploadsbooleanՈչWhether the plugin may currently upload. Requires both an active offload and a usable bucket.
pairedbooleanՈչWhether a plugin token has been issued. The token and its hash are never returned.
plugin_versionstringՈչ
last_seen_atstringՈչWhen the plugin last called. `null` means it never has.
objects_offloadedintegerՈչ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_offloadedintegerՈչ
created_atstringՈչ

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 404 · 429