hosting

POST /v1/sites/{siteId}/wordpress/plugins

Install a plugin on a site's WordPress.

すべての hosting エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/wordpress/plugins \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Installs a plugin and, by default, activates it. Either from the wordpress.org directory by slug (what searchWordPressPluginDirectory returns), or from a zip the customer uploads. ⛔ Exactly one of slug and zip — never both. A request carrying both is refused 422 rather than resolved by precedence, because a caller that sent the wrong one would otherwise install something it did not ask for and be told it succeeded. Idempotent: a plugin already present is activated rather than reinstalled, and an upload of a plugin that is already there replaces it in place. Nothing is ever removed — use deleteSiteWordPressPlugin for that. ⚠️ An uploaded zip is the customer's own code running on their own site, and we do not review it. It is size-capped and rejected unless it is a valid archive containing a single top-level directory with a PHP plugin header, which is what WordPress itself requires — not a security review, and not presented as one. 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).

リクエスト本文

名前タイプ必須これがその内容です
slugstringいいえA wordpress.org directory slug. Lower-case, digits and hyphens — the directory's own alphabet, enforced here so a path separator or a URL can never reach the box as a "slug".
zipstringいいえA base64-encoded plugin zip. Present instead of a multipart upload because every other write on this API is JSON and one exception would need its own auth, size and error handling.
activatebooleanいいえActivate after installing. false puts the files in place and leaves the plugin switched off — what a staged rollout of something risky wants. Deliberately not the default:…

返信

名前タイプ必須これがその内容です
dataSiteWordPressPlugin[]はいThe installed plugins.
stack_cache_installedbooleanはい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…

このエンドポイントが返すエラー

401 · 403 · 404 · 409 · 413 · 422 · 429 · 503