command:pagecache

pagecacheRulesList

pagecacheRulesList [--applicationsId=] [--freeText=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Retrieve and display a list of page cache rules.

• --applicationsId
  The application Ids the rules may be associated with.
• --freeText
  Defined the text string to search in rule details.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

pagecacheSaveRule

pagecacheSaveRule [--ruleId=] --urlScheme= --urlHost= --urlPath= --matchType= --lifetime= [--compress=] [--name=] [--conditionsType=] [--conditions=] [--splitBy=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Create or update a page cache rule.

• --ruleId
  Required when updating an existing rule.
• --urlScheme
  'http', 'https' or 'https?' for all.
• --urlHost
  The issue event group identifier.
• --urlPath
  
• --matchType
  'exactMatch', 'regexMatch' or 'regexlMatch'.
• --lifetime
  
• --compress
  Default TRUE
• --name
  Non empty string.
• --conditionsType
  'and' or 'or'
• --conditions
  
• --splitBy
  
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

pagecacheSaveApplicationRule

pagecacheSaveApplicationRule [--ruleId=] --urlPath= --matchType= --lifetime= [--compress=] [--name=] --applicationId [--conditionsType=] [--conditions=] [--splitBy=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Create or update a page cache rule for a specific application.

• --ruleId
  Required when updating an existing rule.
• --urlPath
  
• --matchType
  'exactMatch', 'regexMatch' or 'regexlMatch'.
• --lifetime
  
• --compress
  Default TRUE
• --name
  Non empty string.
• --applicationId
  
• --conditionsType
  'and' or 'or'
• --conditions
  
• --splitBy
  
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

pagecacheExportRules

pagecacheExportRules [--applicationId=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

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.

• --applicationId
  The issue event group identifier.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

pagecacheImportRules

pagecacheImportRules --paceCacheRules= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Get a list of rules in XML format and store them as global page cache rules.

• --paceCacheRules
  An XML string that describes the rules to be imported. This xml structure is identical to the one returned in pagecacheRules action.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

pagecacheDeleteRules

pagecacheDeleteRules [--rules=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Delete a list of page cache rules.

• --rules
  A list of rule IDs
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

pagecacheRuleInfo

pagecacheRuleInfo --id= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Retrieve and display a page cache rule information.

• --id
  Rule ID.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

pagecacheClearCacheByRuleName

pagecacheClearCacheByRuleName --ruleName= --uri= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Clear all cached items for a specific rule.

• --ruleName
  Rule name.
• --uri
  URI (added in 1.5).
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.

pagecacheClearRulesCache

pagecacheClearRulesCache [--rules=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=] 

Clear all cached items for a specific rule ids (multiple).

• --rules
  List of rule ids.
• --output-format
  Output format. Default is "xml", but you can use "json", or "kv" for key-value.