The pluginDeploy Web API Method

Deploys a plugin.

Version: 1.10

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

pluginPackage

File

Yes

Deploy package file. Content type for the file must be ‘application/vnd.zend.pluginpackage’.

Expected Response Code: 200 OK - Returned for a successful request.

Response Type: plugins

Possible Action Specific Error Codes: This method has no action-specific error codes.

Example

Usage Example

Request

POST /ZendServer/Api/pluginDeploy

Response

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.10">

<requestData>

<apiKeyName>angel.eyes</apiKeyName>

<method>pluginDeploy</method>

</requestData>

<responseData>

<plugin>

<id>13</id>

<name><![CDATA[Zend Framework 3]]></name>

<version><![CDATA[2.0.0]]></version>

<type><![CDATA[type_zray, type_mvc]]</type>

<status><![CDATA[WAITING_FOR_DEPLOY]]></status>

<message><![CDATA[]]></message>

<description><![CDATA[]]></description>

<creationTime>2015-02-22T13:56:50+02:00</creationTime>

<creationTimeTimestamp>1424606210</creationTimeTimestamp>

<servers>

<pluginServer>

<id>0</id>

<status>WAITING_FOR_DEPLOY</status>

</pluginServer>

</servers>

</plugin>

</responseData>

</zendServerAPIResponse>

 

//Error example:

<errorData>

<errorCode>internalServerError</errorCode>

<errorMessage><![CDATA[The plugin Zend Framework 2 1.0.0 alread exists]]></errorMessage>

</errorData>

or:

<errorData>

<errorCode>internalServerError</errorCode>

<errorMessage><![CDATA[Deployment failed: The passed name 'ZF2' doesn't match the package name 'Zend Framework 2']]></errorMessage>

</zendServerAPIResponse>