The applicationGetStatus Web API Method

Get the list of applications currently deployed (or staged) on the server or the cluster and information about each application. If application IDs are specified, this method will return information about the specified applications. If no IDs are specified, this method will return information about all applications on the server or cluster.

Version: 1.2

Required Permissions: Read-only

HTTP method: GET

Supported by Editions:Zend Server

Request Parameters:

Parameter	Type	Required	Description
applications	Array	No	A list of application IDs. If specified, information will be returned about the specific applications only. If not specified, information about all applications will be returned. If a non-existing application ID is provided this action will not fail but instead will return no information about the specific application.
direction	String	No	One of ASC\|DESC. Sets the ordering direction. Ordering is always by User application name.

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

Response Type: applicationsList

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

Example

Usage Example

Request

GET  /ZendServer/Api/applicationGetStatus?applications[]=1&applications[]=2

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>applicationGetStatus</method>
	</requestData>
	<responseData>
		<applicationsList>
			<applicationInfo>
				<id>1</id>
				<baseUrl>http://example.com/myapp</baseUrl>
				<appName>Wordpress</appName>
				<userAppName>Wolfgang's Blog</userAppName>
				<installedLocation>/usr/local/somewhere</installedLocation>
				<status>partiallyDeployed</status>
				<servers>
					<applicationServer>
						<id>1</id>
						<deployedVersion>1.6</deployedVersion>
						<status>OK</status>
					</applicationServer>
					<applicationServer>
						<id>4</id>
						<deployedVersion>1.6</deployedVersion>
						<status>OK</status>
					</applicationServer>
					<applicationServer>
						<id>8</id>
						<deployedVersion>1.5</deployedVersion>
						<status>OK</status>
					</applicationServer>
				</servers>
				<deployedVersions>
					<deployedVersion>1.6</deployedVersion>
					<deployedVersion>1.5</deployedVersion>
					<applicationRollbackVersion>1.5</applicationRollbackVersion>
				</deployedVersions>
				<messageList />
				<creationTime>1970-01-01T02:00:00+02:00</creationTime>
				<lastUsed>1970-01-01T02:00:00+02:00</lastUsed>
			</applicationInfo>
			<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>staging</status>
				<servers>
					<applicationServer>
						<id>1</id>
						<deployedVersion>1.6</deployedVersion>
						<status>staging</status>
					</applicationServer>
					<applicationServer>
						<id>4</id>
						<deployedVersion>1.6</deployedVersion>
						<status>staging</status>
					</applicationServer>
					<applicationServer>
						<id>8</id>
						<deployedVersion>1.5</deployedVersion>
						<status>staging</status>
					</applicationServer>
				</servers>
			<deployedVersions>
				<deployedVersion>1.6</deployedVersion>
				<deployedVersion>1.5</deployedVersion>
			</deployedVersions>
			<messageList />
				<creationTime>1970-01-01T02:00:00+02:00</creationTime>
				<lastUsed>1970-01-01T02:00:00+02:00</lastUsed>
			</applicationInfo>
		</applicationsList>
	</responseData>
</zendServerAPIResponse>

Important Note:

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