The configurationExtensionsList Web API Method

Retrieve a list of extensions and associated information. This list can be filtered by extension type (PHP Extension and Zend Extension). This list of extensions contains only meta and operation information about the extension, and does not include directives and internal state.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: All

Request Parameters:

Directives and their values are passed as HTTP parameters in the “directives” namespace, directly into the query part of the Request

Parameter	Type	Required	Description
type	String	No	Retrieve only extensions of a specific type (one of “all”, ”zend”, “php”). Default: All
order	String	No	Column to sort the result by (name, status). Default: (extension) name
direction	String	No	Sorting direction: ASC or DESC. Default: ASC
filter	String	No	Apply a certain case-insensitive string filter to the extensions returned

Expected Response Code: 200 OK

Response Type: A list of extensions, current meta data, state and description.

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
500	internalServerError	The system could not retrieve the requested extensions’ information, possibly due to a database error.

Example

Usage Example

Request

GET /ZendServer/Api/configurationExtensionsList?extension=php&order=name&direction=ASC

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>configurationExtensionsList</method>
	</requestData>
	<responseData>
		<extensions>
			<extension>
			<name>bcmath</name>
			<version>1.0</version>
			<type>php</type>	
			<status>Off</status>
			<loaded>yes</loaded>
			<installed>yes</installed>
			<builtIn>no</builtIn>
			<dummy>no</dummy>
			<shortDescription><![CDATA[Extension shortdescription]]></shortDescript>
			<longDescription><![CDATA[Extension longdescription]]></longDescription>
			<messageList />
		</extension>
		<extension>
			<name>session</name>
			<version>1.2</version>
			<type>php</type>
			<status>OK</status>
			<loaded>yes</loaded>
			<installed>yes</installed>
			<builtIn>yes</builtIn>
			<dummy>no</dummy>
			<shortDescription><![CDATA[Extension shortdescription]]></shortDescript>
			<longDescription><![CDATA[Extension longdescription]]></longDescription>
			<messageList />
		</extension>
		</extensions>
	</responseData>
</zendServerAPIResponse>