Web API Reference Guide > Available API Methods > Deployment Methods > The deploymentDownloadFile Method

The deploymentDownloadFile Method

Download a deployment package file from a given URL to allow passing it to the deployment mechanism later.

Version: 1.6

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
url	String	Yes	Package URL.
name	String	Yes	Package name.
version	String	Yes	Package version.
override	Boolean	No	Determines whether the download file should be overridden in case it is already being processed. Default to false.

Expected Response Code: 200 OK - For more information see Response Format.

Response Type: Data on how to manage vhost

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
400	deploymentDownloadAlreadyExists	Download request for this url was already started and in progress.
400	missingParameter	A required parameter is missing.
400	invalidParameter	A value provided for a parameter is invalid.

Example

Usage Example

Request

POST /ZendServer/Api/deploymentDownloadFile
url=http://www...&name=ZendFramework&version=2.4

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>deploymentDownloadFile</method>
	</requestData>
	<responseData>
		<status>Ok</status>
	</responseData>
</zendServerAPIResponse>

	Read Also
	Available API Methods
	Deployment Methods