hosting
PUT /v1/sites/{siteId}/wordpress/plugins/{pluginName}
Activate or deactivate a plugin on a site.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/wordpress/plugins/{pluginName} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "active": <boolean> }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Sets whether the plugin is active, and returns the whole plugin listing so the card re-renders from the server's answer. The plugin is addressed by **path** rather than by a field in the body, so activate and delete cannot be confused for one another by a caller that got a body wrong. Deactivating a plugin can take a live site's checkout, cache or security layer with it. Refused `422` when the package type does not carry `wp_plugins`, or when WordPress is not installed. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
pluginName (path) | string | はい | The plugin's slug, exactly as `listSiteWordPressPlugins` reports it. It is WordPress's identifier, not ours, so percent-encode it; a slug containing a slash does not route and a… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
active | boolean | はい | Whether the plugin should be running after this call. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | SiteWordPressPlugin[] | はい | The installed plugins. |
stack_cache_installed | boolean | はい | ⛔ **Cannot be derived from `data`.** this platform excludes its own server-side cache plugin from the listing, so a client deriving this flag from the rows would answer "not ins… |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429 · 503