Web API Reference Guide > Available API Methods > Page Cache Methods > The pagecacheExportRules Method

The pagecacheExportRules Method

Create an XMLdocument that contains all page cache rules for an application. This document conforms to the structure required by the Deployment package to include rules in a zpk.

Note that this action returns an unusual XMLformat and does not conform to the rest of the API in terms of structural conformity. The XSD for validating the document is provided in the appendices at the end of the document.

Also note that this action returns only an XML output - it is not allowed to return a JSON format and an 406 error will be returned for a JSON output request.

Version: 1.3

Required Permissions: Full

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:

Parameter	Type	Required	Description
applicationId	Integer	No	Application to retrieve rules for. Default: Global rules

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

Possible Action Specific Error Codes:

HTTP Code	Error Code	Description
406	outputTypeLimited	This action does not have a JSON formatted response

Example

Usage Example

Request

GET /ZendServer/Api/pagecacheExportRules?applicationId=2

Response

HTTP/1.0 200 OK
<?xml version="1.0" ?>
<cache_settings><dont_cache/>
	<cache>
		<url lifetime="360" match_type="regex_match" schema="http" host="" path="time.php" id="" compress="true" app_id="6"><name><![CDATA[time]]></name></url>
	</cache>
</cache_settings>

	Read Also
	Available API Methods
	Page Cache Methods