The configurationImport Web API Method

Import a saved configuration snapshot into the server.

Version: 1.1

Required Permissions: Full

HTTP method: POST

Supported by Editions: All

Request Parameters: Because this method is expected to contain a file upload, parameters are expected to be encoded using the ‘multipart/form-data’ content type.

Parameter	Type	Required	Description
configFile	File	Yes	The configuration snapshot file to import. Content-type for the file must be "application/vnd.zend.serverconfig".
ignoreSystemMismatch	Boolean	No	If set to TRUE, configuration must be applied even if it was exported from a different system (other major PHP version, Zend Server version or operating system). The default value is FALSE.

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

Response Type: serversList with information about affected servers.

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
500	importFailed	Importing the configuration snapshot failed.
409	systemMismatch	The system type, PHP version or Zend Server version from which the configuration snapshot was exported does not match the current system. This error can be overridden if the ignoreSystemMismatch parameter is set to TRUE.

Example

Usage Example

Request (some headers removed for clarity)

POST /ZendServer/Api/configurationImport
Content-type: multipart/form-data, boundary=--bla-bla-bla--
----bla-bla-bla--
Content-disposition: form-data; name=ignoreSystemMismatch
TRUE
----bla-bla-bla--
Content-disposition: form-data; name=”configFile”; 
filename=”mySavedConfig.zcfg”
Content-type: application/vnd.zend.serverconfig
[...binary data follows...]
----bla-bla-bla----

Response

HTTP/1.0 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.0">
	<requestData>
		<apiKeyName>angel.eyes</apiKeyName>
		<method>configurationImport</method>
	</requestData>
	<responseData>
		<serversList>
			<serverInfo>
			<id>12</id>
			<name>www-01</name>
			<address>www-01.local</address>
			<status>pendingRestart</status>
			<messageList>
			<warning>This server is waiting a PHP restart</warning>
			</messageList>
			<debugModeEnabled>true</debugModeEnabled>
		</serverInfo>
		<serverInfo>
			<id>15</id>
			<name>www-02</name>
			<address>www-02.local</address>
			<status>pendingRestart</status>
			<messageList>
			<warning>This server is waiting a PHP restart</warning>
			</messageList>
			<debugModeEnabled>true</debugModeEnabled>
		</serverInfo>
		</serversList>
	</responseData>
</zendServerAPIResponse>