Perform a Plug-in Action
post
/{versionId}/admin/plugins/{pluginId}/action
Install, uninstall, replace, or recover a plugin. One action per plug-in is allowed at the same time. For the recover action, the first failed host is recovered if there are more than one failed hosts. The REST client needs to use the Get Plug-in Information task to check on the status.
Request
Path Parameters
Back to Top
Response
200 Response
400 Response
The user input is invalid.
401 Response
The session ID is invalid.
403 Response
There is no permission to access the resources.
404 Response
The object (resource URI, device, and so on) of your input request cannot be found.
500 Response
Internal server error
Examples
Examples of Accessing the API
See Authenticate for how to acquire a session cookie.
The following example shows how to perform a plug-in action using curl.
curl -X POST \
-b sessionid.txt \
-d@request.xml \
--header "Accept: application/xml" \
--header "Content-Type: application/xml" \
"https://example.com:8443/rest/v1.3/admin/plugins/ID7/action"The following example shows how to perform a plug-in action using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/admin/plugins/ID7/action"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)Example of the Request Body
The following example shows the contents of the request body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pluginAction>
<type>install</type>
</pluginAction>The following example shows the contents of the request body in JSON.
{
"type": "install"
}Example of the Response Body
This endpoint does not return a response body.