The configurationDirectivesList Web API Method

Retrieve a filtered list of directives and associated information. This list can be filtered by extension name, however if an invalid or non-existing extension is passed, an valid empty result will be returned.

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
extension	String	No	Retrieve only directives of a specific extension. Default: Retrieve all known directives regardless of extensions. If no extension name is provided, the output will be modified so that the extension element is empty
daemon	String	No	Retrieve only directives of a specific zend daemon. Note that both extension and daemon parameters cannot be passed.
filter	String	No	Filter out the directives returned according to a certain text.

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

Response Type: A list of directives, 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

Figure 1. Request

GET /ZendServer/Api/configurationDirectivesList?extension=mysql

Figure 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>configurationDirectivesList</method>
	</requestData>
	<responseData>
		<directives>
			<directive>
				<name>directive_name</name>
				<section>server</section>
				<type>string</type>
				<fileValue><![CDATA[directive value]]></fileValue>
				<defaultValue><![CDATA[directive default value]]></defaultValue>
				<previousValue><![CDATA[directive previous value]]></previousValue>
				<units><![CDATA[bytes]]></units>
				<listValues>
					<listValue><![CDATA[Value]]></listValue>
				</listValues>
			</directive>
		</directives>
	</responseData>
</zendServerAPIResponse>