The pagecacheSaveResponseRule Web API Method

Creates or updates a page cache response rule.

Version:1.16

Required Permissions: Full

HTTP method: POST

Supported by Editions: Zend Server

Request Parameters:  

Parameter

 Type

Required

Description

applicationId

integer

No

-1 (global) is the default

responseConditions

array

No

An array of elements with the structure: {element, type, value}

inheritGlobals

boolean-string

Yes

Either "TRUE" or "FALSE"

responseCode

string

No

A non-empty string

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

Response Format: The rule information.

Possible Action Specific Error Codes:

HTTP Code

Error Code

Description

500

internalServerError

Creation of rule failed due to an internal problem

Example

Usage Example

Request

GET/ZendServer/Api/pagecacheSaveResponseRule
urlScheme=http&urlHost=myHost&urlPath=index.php&lifetime=360

Response

{
"responseData": {
  "rulesInfo": {
    "rule": {
      "application": "",
      "applicationId": -1,
      "conditions": [
        {
          "element": "s",
          "type": "equals",
          "value": "fsdf"
        }
      ]
    }
  },
"globalInheritance": 1,
"responseStatus": "500"
}