The pluginSynchronize Web API Method

Redeploys a plugin.

Version: 1.10

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
pluginId	Integer	Yes	Plugin identifier

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

Response Type: plugin

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

Example

Usage Example

Request

POST /ZendServer/Api/pluginSynchronize

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.10">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>pluginSynchronize</method>
	</requestData>
	<responseData>
		<plugins>
			<plugin>
				<id>8</id>
				<name><![CDATA[Wordpress]]></name>
				<version><![CDATA[1.0.0]]></version>
				<type><![CDATA[type_zray, type_mvc]]</type>
				<status><![CDATA[WAITING_FOR_REDEPLOY]]></status>
				<message><![CDATA[]]></message>
				<description><![CDATA[]]></description>
				<creationTime>2015-02-17T13:05:29+02:00</creationTime>	
				<creationTimeTimestamp>1424171129</creationTimeTimestamp>
				<servers>
					<pluginServer>	
						<id>0</id>
						<status>WAITING_FOR_REDEPLOY</status>
					</pluginServer>
				</servers>
			</plugin>                       
		</plugins>
	</responseData>
</zendServerAPIResponse>

Example of error (plugin does not exist):

	<errorData>
		<errorCode>noSuchPlugin</errorCode>
		<errorMessage><![CDATA[This plugin 1 does not exist]]></errorMessage>
	</errorData>
</zendServerAPIResponse>