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

The pagecacheImportRules Method

Receives a list of rules in XML format, and stores them as global page cache rules.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

paceCacheRules

String

Yes

An XML string that describes the rules to be imported. This xml structure is identical to the one returned in pagecacheRules action

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

Possible Action Specific Error Codes: This action has no specific error codes.

Example

Usage Example

Request

POST /ZendServer/Api/pagecacheImportRules

Include attached uploaded XML file with rules

Response

HTTP/1.0 200 OK

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">

<requestData>

<apiKeyName><![CDATA[Admin]]></apiKeyName>

<method>pagecacheIsImported</method>

</requestData>

<responseData>

<pagecacheIsImported>True</pagecacheIsImported>

</responseData>

</zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Page Cache Methods