v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Plugins

Install new WordPress plugins to site

Endpoint that can be used to install one or more WordPress plugins for given site.

post/v1/sites/{id}/plugins

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

pluginsstring

Comma separated list of plugins to install. Cannot be combined with 'custom_url'

activateboolean

If all the plugins that are being installed should be activated

custom_urlstring

If a plugin should be downloaded from a custom URL rather than the wordpress.org plugin library, this is the download URL. Cannot be combined with 'plugins'

Example request

{
  "plugins": "akismet,hello"
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "name": "akismet",
      "version": "5.3.3"
    }
  ]
}