The applicationRemove Web API 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.

Version: 1.2

Required Permissions: Full

HTTP method: POST

Supported by Editions:Zend Server

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.

Example

Usage Example

Request

POST /ZendServer/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.3">
	<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/>
				<creationTime>1970-01-01T02:00:00+02:00</creationTime>
				<lastUsed>1970-01-01T02:00:00+02:00</lastUsed>
			</applicationInfo>
		</responseData>
</zendServerAPIResponse>
For Zend Server on Linux, this action is also available via the command line using CLI tools. For more information, see ZendServerSDK.