Install component

View as Markdown
Installs a plugin or theme from the wordpress.org repository on the selection: one `manager.install` Site Action per accepted site.\n\nBody parameters:\n- `type` (string, required): `plugin` | `theme`.\n- `from` (string, required): only `repository` is accepted on this surface (`url`/`upload` answer 422).\n- `value` (string, max 200, required): the wordpress.org slug, as in its URL (e.g. `woocommerce`).\n- `sites` (integer array, required): exact ids, 1 to 200.\n- `activate` (boolean `1`/`0`, default `0`): activate right after installing.\n- `overwrite` (boolean `1`/`0`, default `0`): reinstall over an existing copy instead of skipping the site.\n- `clean_cache` (boolean `1`/`0`, default `0`): clear each site's cache after installing.\n\n202 with the created `site-actions` documents and `meta.skipped`.\n\n- **422**: `sites` missing/empty/over 200/unknown id; `from` other than `repository`; `value` not a slug wordpress.org resolves.\n- **403**: a read-only token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
fromstringRequired
typestringRequired
siteslist of integersRequired
valuestringRequired
activateintegerRequired

Response

Successful response