Get Cache Control Rules

Retrieve a list of cache control rules for website accleration domain.

Request

Request-Line

GET /waap/v1.0/services/{serviceId}/cacheControls HTTP/1.1

Request Parameters

Path Parameters

Parameter	Type	Required	Description
serviceId	Integer	Mandatory	Service ID.

Response

Response Body

Parameter	Type	Description
	Array	Array of Url Cache Controls Rule.

Object: Url Cache Controls Rule

Parameter	Type	Description
ruleId	Integer	Rule ID number for access control.
name	String	Rule name for access control.
matchUrlPath	Object	URL path matching configuration that determines which requests the rule applies to. See Match Url Path for details.
matchQueryString	Object	Query-string matching configuration used to refine which requests the rule applies to. See Match Query String for details.
priority	Integer	Priority weight for the rule. Rules with a higher weight take precedence. The weight must be non-zero.
ttl	Long	Time-to-live (TTL) in seconds for content cached at the edge. If omitted, the origin cache TTL is used.
ignoreClientNoCache	Boolean	Indicates whether to ignore no-cache headers sent by the client. Accepts true or false.
ignoreOriginNoCache	Boolean	Indicates whether to ignore no-cache headers sent by the origin server. Accepts true or false.
ignoreQueryString	Boolean	Indicates whether to ignore the URL query string when caching content. Accepts true or false.
enableXCache	Boolean	When enabled, all responses from the edge include an X-Cache header (e.g., "HIT from da01.xy01.swiftserve.com"), indicating whether the response was served from cache (fully or partially) or not.
neverCache	Boolean	Prevents content from being cached, even if the origin marks it as cacheable.
varyMIMEs	String[]	Configures so-called "vary for images" feature. Contains a list of mime types, preferred for objects matched by the rule. Supported values: image/webp, image/avif, image/jpeg, image/jpg, image/png
enabled	Boolean	Indicates whether the rule is enabled.

Object: Match Url Path

Parameter	Type	Description
operator	String	Defines how to match the field. Supported values:prefix,regex,equals,suffix.
patterns	String[]	List of patterns matching the URL path/query string.

Object: Match Query String

Parameter	Type	Description
operator	String	Defines how to match the field. Supported values:prefix,regex,equals,suffix.
patterns	String[]	List of patterns matching the URL path/query string.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	ServiceId.Invalid	ServiceId is empty or invalid.
400	CacheControl.OperationFailed	The cache control operation failed.
404	ServiceId.NotFound	ServiceId is not found.

Examples

Get Cache Control Rules

Request

GET /waap/v1.0/services/12345/cacheControls HTTP/1.1

Successful Response Body

[
    {
        "ruleId": 261699,
        "name": "test1",
        "matchUrlPath": {
            "operator": "prefix",
            "patterns": [
                "/"
            ]
        },
        "priority": 1023,
        "ignoreClientNoCache": false,
        "ignoreOriginNoCache": false,
        "ignoreQueryString": false,
        "enableXCache": false,
        "neverCache": false,
        "enabled": true
    },
    {
        "ruleId": 261700,
        "name": "test",
        "matchUrlPath": {
            "operator": "prefix",
            "patterns": [
                "/"
            ]
        },
        "matchQueryString": {
            "operator": "prefix",
            "patterns": [
                "name1=1",
                "name2=2"
            ]
        },
        "priority": 1,
        "ttl": 100,
        "ignoreClientNoCache": true,
        "ignoreOriginNoCache": false,
        "ignoreQueryString": false,
        "enableXCache": false,
        "neverCache": false,
        "varyMIMEs": [
            "image/jpg"
        ],
        "enabled": true
    }
]