hosting
DELETE /v1/sites/{siteId}/media-offload
Revoke the plugin's token and stop new uploads.
認証
ベアラー トークンとして API キーを送信します。キーには storage.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
configured | boolean | はい | `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 | いいえ | — |
site_id | string | いいえ | — |
bucket_id | string | いいえ | — |
status | string<awaiting_pairing, active, paused, revoked> | いいえ | — |
prefix | string | いいえ | The key prefix this site's objects live under. |
rewrite_urls | boolean | いいえ | 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 | いいえ | 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 | いいえ | 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 | いいえ | 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 | いいえ | `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 | いいえ | Whether the plugin may currently upload. Requires both an active offload and a usable bucket. |
paired | boolean | いいえ | Whether a plugin token has been issued. The token and its hash are never returned. |
plugin_version | string | いいえ | — |
last_seen_at | string | いいえ | When the plugin last called. `null` means it never has. |
objects_offloaded | integer | いいえ | 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 | いいえ | — |
created_at | string | いいえ | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 429