Web API Reference Guide > Available API Methods > Configuration Management Methods > The configurationComponentsList Method

The configurationComponentsList Method

Retrieve a list of zend components and associated information. Each component holds information both on it’s extension and it’s daemon (service). If the component does not have a daemon, then daemon status returned is ‘None’.

Version: 1.3

Required Permissions: Full

HTTP method: GET

Supported by Editions: All

Request Parameters:

Parameter	Type	Required	Description
filter	String	No	Apply a certain case-insensitive string filter to the components returned.

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

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 components’ information, possibly due to database error

Example

Usage Example

Request (headers removed for clarity)

GET /ZendServer/Api/configurationComponentsList

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>configurationComponentsList</method>
	</requestData>
	<responseData>
		<components>
			<component>
				<extension>
					<name>Zend Job Queue</name>
					<version>4.0</version>
					<type>zend</type>
					<status>Loaded</status>
					<loaded>true</loaded>
					<installed>true</installed>
					<builtIn>false</builtIn>
					<dummy>false</dummy>
					<restartRequired>false</restartRequired>
					<shortDescription><![CDATA[Provides offline asynchronous processing of tasks and activities]]></shortDescription>
					<longDescription><![CDATA[Zend Server's Job Queue is a monitored, manageable job queuing system, which can be easily integrated with PHP applications. It provides the ability to take certain tasks preformed by your PHP applications off-line, and queue them to execute asynchronously, or even at a later time or in a recurring manner.]]></longDescription>
					<messageList><![CDATA[]]></messageList>
				</extension>
				<daemon>
					<name>jqd</name>
					<status>OK</status>
					<restartRequired>false</restartRequired>
					<shortDescription><![CDATA[Zend Job Queue Daemon]]></shortDescription>
					<longDescription><![CDATA[The Zend Job Queue Daemon is the daemon that executes jobs]]></longDescription>
					<messageList><![CDATA[]]></messageList>
				</daemon>
			</component>
		</components>
	</responseData>
</zendServerAPIResponse>

Important Note:

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

	Read Also
	Available API Methods
	Configuration Management Methods