WebAPI Reference Guide > Available API Methods > Configuration Management Methods > The configurationSearch Method

The configurationSearch Method

Retrieve a list of extension and directive names that correspond to a search executed on a filter.

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
filter	String	No	Default: All directives and extensions
query	String	Yes

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

Response Type: A list of extensions and directives which correspond to the requested query and filter. Directives found matching the query also have a corresponding extension entry, even if the extension does not actually have a match on its own.

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 /ZendServerManager/Api/configurationSearch?query=gob&filter=All+Extensions

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>configurationSearch</method>
	</requestData>
	<responseData>
		<extensions>
			<extension>
				<name>extension_name</name>
				<version>1.0</version>
				<type>php</type>
				<loaded>yes</loaded>
				<installed>yes</installed>
				<builtIn>yes</builtIn>
				<shortDescription><![CDATA[Extension description]]></shortDescript>
				<description><![CDATA[Extension description]]></description>
			</extension>
			<extension>
				<name>gob_extension</name>
				<version>1.2</version>
				<type>php</type>
				<loaded>yes</loaded>
				<installed>yes</installed>
				<builtIn>yes</builtIn>
				<shortDescription><![CDATA[Extension description]]></shortDescript>
				<description><![CDATA[Extension description]]></description>
			</extension>
		</extensions>
		<directives>
			<directive>
				<name>gobligook</name>
				<extension>gob_extension</extension>
				<section>server</section>
				<type>string</type>
				<fileValue><![CDATA[directive value]]></fileValue>
				<defaultValue><![CDATA[directive default value]]><</defaultValue>
			</directive>
		</directives>
	</responseData>
</zendServerAPIResponse>


	Related Links: Available API Methods