The applicationDetachVhosts Web API Method

Detaches virtual hosts from the app identified by the appId. The virtual hosts are identified by the vhostsIds that are passed in the vhosts[] array. Restarts the web server after the configuration has been updated in the file system. Only the configuration of the vhost that is to be detached is modified. Active symlinks are not modified. The method returns true on success.

Version: 1.15

Required Permissions: Read-only

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
appId	Integer	Yes	The ID of the application which you want to detach from the vhosts.
vhosts	Array	Yes	Array of Id(s) of the vhosts to detach.

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

Response Type: applicationsDetails

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

Example

Usage Example

Request

POST /ZendServer/Api/applicationDetachVhosts?appId=1&vhosts[]=3&vhosts[]=4

Response

{result : true}

Important Note:

For Zend Serveron Linux, this action is also available via the command line using CLI Tools. For more information see CLI Tools.