The libraryGetStatus Web API Method

Get the list of libraries currently deployed on the server or the cluster, and information about each library’s available versions. If library IDs are specified, will return information about the specified applications; If no IDs are specified, will return information about all libraries.

Version: 1.5

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
libraries	Array	No	List of library IDs. If specified, information will be returned about these applications only. If not specified, information about all applications will be returned. Note that if a non-existing application ID is provided, this action will not fail but instead will return no information about the specific app.
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: libraryList

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

Example

Usage Example

Request

GET /ZendServer/Api/libraryGetStatus?libraries[]=1&libraries[]=2

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.5">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>libraryGetStatus</method>
	</requestData>
	<responseData>
		<libraryList>
			<libraryInfo>
				<libraryId>1</libraryId>
				<libraryName>Zend Framework</libraryName>
				<status>Ok</status>
				<libraryVersions>
					<libraryVersion>
					<libraryVersionId>1</libraryVersionId>
					<version>1.12.1</version>
					<default>true</default>
					<status>Ok</status>
				<installedLocation><![CDATA[/path/to/lib]]></installedLocation>
				<isDefinedLibrary>false</isDefinedLibrary>
				<creationTime>1970-01-01T02:00:00+02:00</creationTime>
				<lastUsed>1970-01-01T02:00:00+02:00</lastUsed>
				<servers>
					<libraryServer>
						<serverId>1</serverId>
						<status>OK</status>
					</libraryServer>
					<libraryServer>
						<serverId>4</serverId>
						<status>OK</status>
					</libraryServer>
					<libraryServer>
						<serverId>8</serverId>
						<status>OK</status>
					</libraryServer>
				</servers>	
			</libraryVersion>
		</libraryVersions>
	</libraryInfo>
	<libraryInfo>
		<libraryId>2</libraryId>
		<libraryName>Zend Framework 2</libraryName>
		<status>Ok</status>
		<isDefinedLibrary>false</isDefinedLibrary>
		<libraryVersions>
			<libraryVersion>
				<libraryVersionId>2</libraryVersionId>
				<version>2.0.1</version>
				<default>false</default>
				<status>Ok</status>
				<installedLocation><![CDATA[/path/to/lib]]></installedLocation>
				<creationTime>1970-01-01T02:00:00+02:00</creationTime>
				<lastUsed>1970-01-01T02:00:00+02:00</lastUsed>
				<servers>
					<libraryServer>
						<serverId>1</serverId>
						<status>OK</status>
					</libraryServer>
					<libraryServer>
						<serverId>4</serverId>
						<status>OK</status>
					</libraryServer>
					<libraryServer>
						<serverId>8</serverId>
						<status>OK</status>
					</libraryServer>
				</servers>
				<libraryVersion>
				</libraryVersions>
			</libraryInfo>
		</libraryList>
	</responseData>
</zendServerAPIResponse>