Web API Reference Guide > Available API Methods > Virtual Hosts Methods > The vhostEnableDeployment Method

The vhostEnableDeployment Method

Enable deployment to a system virtual host. This action requires user intervention.

Enabling deployment is performed in two stages:

A file is created to contain the overriding virtual host configuration.
A blueprint entry is created to control and monitor the virtual host (performed if applyImmediately is TRUE)

After these two steps, the user is expected to link this new configuration file to the server’s virtual host section of the configuration file. This step is required because Zend Server generally does not have the write permissions needed to perform the action.

The split to two workflow modes allows the user to create a minimal setup, complete the file system part of the workflow and only then enforce blueprint control. Changes will come into effect only after a full restart anyway.

Version: 1.6

Required Permissions: Read only

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter

Type

Required

Description

vhost

Integer

Yes

The ID of a single virtual host.

applyImmediately

Boolean

False: will only create an overriding configuration file.

True: will create an overriding configuration.

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
404	noSuchVhost	Required virtual host ID was not found.

Example

Usage Example

Request

POST /ZendServer/Api/vhostEnableDeployment?vhost=1

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.6">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>vhostEnableDeployment</method>
	</requestData>
	<responseData>
		<manageInfo>
			<addLine><![CDATA[include /path/to/include/path]]></addLine>
			<toPath><![CDATA[/path/to/file]]></toPath>
		</manageInfo>
	</responseData>
</zendServerAPIResponse>

	Read Also
	Available API Methods
	Virtual Hosts Methods