REST API for Session Delivery Manager Release 8.1

Perform a Plug-in Action

post

/rest/{versionId}/admin/plugins/{pluginId}/action

Use this (POST) method to 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

Supported Media Types

application/xml
application/json

Path Parameters

pluginId: string
versionId: string

Root Schema : pluginAction

Type: object

Show Source

type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "xml":{
        "name":"pluginAction"
    }
}

Response

Supported Media Types

application/xml
application/json

202 Response

Accepted

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

The following example shows how to install a specified plugin by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

<curl>

Example of cURL Data

The following shows an example of cURL data sent with the request.

<data>curl -v -b sessionid.txt -X POST -d@plugin/actPlugin.xml -H"Content-Type: application/xml" http://localhost:8080/rest/v1.1/admin/plugins/ID6/action

Example of Request Body

The following shows an example of the user request body input in XML format.

<?xml version="1.0" encoding="UTF-8"?>
<pluginAction>
  <type>Install</type>
</pluginAction>
				
</pre>

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Date: Thu, 07 Sep 2017 16:21:26 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Content-Length: 0