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

The configurationExtensionsOff Method

Deactivates an extension by unloading it. This action requires a restart be performed on the server to apply the change.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: All

Request Parameters:

Parameter	Type	Required	Description
extensions	Array	Yes	List of extensions to deactivate

Expected Response Code: 202 Accepted. For more information see Response Format.

Response Type: The extension’s details and state after the deactivation request was accepted

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
404	noSuchExtension	The requested extension was not found
500	internalServerError	The system could not retrieve the requested extensions’ information, possibly due to database error

Example

Usage Example

Request

POST /ZendServer/Api/configurationExtensionsOff
extensions[0]=bcmath

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>configurationExtensionsOff</method>
	</requestData>
	<responseData>
		<extensions>
			<extension>
				<name>extension_name</name>
				<version>1.0</version>
				<type>bcmath</type>
				<loaded>yes</loaded>
				<installed>yes</installed>
				<builtIn>yes</builtIn>
				<shortDescription><![CDATA[Extension description]]></shortDescription>
				<description><![CDATA[Extension description]]></description>
			</extension>
		</extensions>
	</responseData>
</zendServerAPIResponse>

	Read Also
	Available API Methods
	Configuration Management Methods