The pagecacheDeleteRules Web API Method

Delete a list of page cache rules.

Version: 1.3

Required Permissions: Read-only

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

rules

array

No

A list of rule IDs

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

Deleting a list of rules failed due to an internal problem

Example

Usage Example

Request

POST /ZendServer/Api/pagecacheDeleteRules
rules[]=1&rules[]=2

Response

<?xml version="1.0" encoding="UTF-8"?>
<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">
	<requestData>
		<apiKeyName><![CDATA[Admin]]></apiKeyName>
		<method>pagecacheDeleteRules</method>
	</requestData>
	<responseData>
		<rules>
			<rule>
				<ruleId>1</ruleId>
				<urlScheme>http</urlScheme>
				<urlHost>localhost</urlHost>
				<urlPath>index.php</urlPath>
				<type>exact_match</type>
				<application></application>
				<applicationId>-1</applicationId>
				<name></name>
			</rule>
			<rule>
				<ruleId>2</ruleId>
				<urlScheme>http</urlScheme>
				<urlHost>localhost</urlHost>
				<urlPath>index.php</urlPath>
				<type>exact_match</type>
				<application></application>
				<applicationId>-1</applicationId>
				<name></name>
			</rule>
		</rules>
		<total>2</total>
	</responseData>
</zendServerAPIResponse>