You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.

You are here: Web API Reference Guide > Available API Methods > Deployment Methods > The applicationRemove Method

The applicationRemove Method

This method allows you to remove an existing application. This process is asynchronous, meaning the initial request will start the removal process and the initial response will show information about the application being removed. However, the removal process will proceed after the response is returned. You must continue checking the application status using the applicationGetStatus method until the removal process is complete. Once applicationGetStatus contains no information about the application, it has been completely removed

Required Permissions: full

HTTP method: POST

Supported by Editions:Zend Server, Zend Server Cluster Manager

Request Parameters:

Parameter	Type	Required	Description
appId	Integer	Yes	The application ID you would like to update.

Expected Response Code: 202 Accepted - For more information see Response Format.

Response Type: applicationInfo

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
404	noSuchApplication	One or more of the provided application ID's does not exist.

Usage Example

Example:

Request:

POST /ZendServerManager/Api/applicationRemove
Content-type: application/x-www-form-urlencoded

appId=5

Response:

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

     <responseData>
            <applicationInfo>
                <id>2</id>
                <baseUrl>http://oapp.example.com:8080/</baseUrl>
                <appName>Blog 2.0</appName>
                <userAppName>Wolfgang's Blog</userAppName>
                <installedLocation>/usr/local/somewhere</installedLocation>
                <status>removing</status>
                     <servers>
                           <applicationServer>
                                <id>1</id>
                                <deployedVersion>1.6</deployedVersion>
                                <status>removing</status>
                           </applicationServer>
                           <applicationServer>
                                <id>4</id>
                                <deployedVersion>1.6</deployedVersion>
                                <status>removing</status>
                           </applicationServer>
                           <applicationServer>
                                <id>8</id>
                                <deployedVersion>1.6</deployedVersion>
                                <status>removing</status>
                            </applicationServer>
                       </servers>
                       <deployedVersions>
                            <deployedVersion>1.6</deployedVersion>
                       </deployedVersions>
                <messageList />
            </applicationInfo>
    </responseData>
</zendServerAPIResponse>

Important Note:

For Zend Server or Zend Server Cluster Manager on Mac or Linux, this action is also available via the command line using CLI Tools. For more information see CLI Tools.


	Related Links: Deployment Methods