The pagecacheRulesList Web API Method

Retrieve and display a list of page cache rules.

Version: 1.3

Required Permissions: Read-only

HTTP method: GET

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

applicationsId

array

No

The application Ids the rules may be associated with

freeText

string

No

Free test to search in rule details

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

Response Format: A list of rules, their dependent information and a total count of records for the provided filter.

Possible Action Specific Error Codes:

HTTP Code

Error Code

Description

500

internalServerError

Retrieving a list of rules failed due to an internal problem

Example

Usage Example

Request

GET/ZendServer/Api/pagecacheRulesList

Response

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

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

<requestData>

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

<method>pagecacheRulesList</method>

</requestData>

<responseData>

<rules>

<rule>

<id>1</id>

<type>0</type>

<application></application>

<name>rule1</name>

<url>http://localhost/rule1</url>

</rule>

<rule>

<id>2</id>

<type>0</type>

<application></application>

<name>rule2</name>

<url>http://localhost/rule2</url>

</rule>

</rules>

<total>2</total>

</responseData>

</zendServerAPIResponse>