You are currently viewing Zend Server 5.x documentation. Click here to view the latest Zend Server online documentation.

You are here: Web API Reference Guide > Available API Methods > Configuration Management Methods > The configurationExport Method

The configurationExport Method

Export the current server/cluster configuration into a file.

Required Permissions: read

HTTP method: GET

Supported by Editions: All

Request Parameters: This method has no request parameters

Expected Response Code: 200 OK

Response Format: A successful call to the configurationExport method results in an HTTP response with the configuration snapshot file in the response body.

The content type for the configuration snapshot file is “application/vnd.zend.serverconfig”. In addition, the response includes a Content-disposition header, specifying a suggested file name for the configuration snapshot file.

Note:

This is different from most Web API calls where the content type is expected to be “application/vnd.zend.serverpi+xml; version=…” and the response body payload is expected to be in XML format.

In case of an error, a regular error response will be returned containing an <errorData> element as defined for other Web API methods.

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
500	exportFailed	Creating a configuration snapshot failed.

Usage Example

Example:

Request (headers removed for clarity):

GET /ZendServerManager/Api/configurationExport

Response (not all headers are shown):

HTTP/1.0 200 OK
Content-type: application/vnd.zend.serverconfig
Content-disposition: attachment;
filename=”ZendServerConfig-20101123.zcfg”

[...binary data follows...]

Important Note:

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