Supported Behaviors
Following is a listing of behaviors supported in the current version of the API.
origin
Modifies the origin server for the request, along with other related options.
| Type(s)/Param(s) | Example Values |
|---|---|
| params: digitalProperty, originDomain, cacheKeyType, cacheKeyValue, hostHeaderType, hostHeaderValue |
"name":"origin", "value" : "-", "params" : { "digitalProperty" : "www.example.com", "originDomain" : "origin.com", "cacheKeyType" : "origin", "hostHeaderType" : "digital_property", "hostHeaderValue" : "-", "cacheKeyValue" : "-"} |
caching
Allows control over the caching behaviors
| Type(s)/Param(s) | Example Values |
|---|---|
| type: no-store, bypass-cache, fixed, honor, honor-cc, honor-expires |
"name":"caching", "type":"fixed", "value":"1d" |
cachekey-query-args
Controls which query arguments are included in the cache-key.
| Type(s)/Param(s) | Example Values |
|---|---|
| type: include, include-all, ignore, ignore-all |
"name":"cachekey-query-args", "type":"ignore", "value":"sessionid" |
content-refresh
Schedules a revalidation of the content.
| Type(s)/Param(s) | Example Values |
|---|---|
| type: epoch, date, datetime, natural params: mustRevalidate |
"name":"content-refresh", "type":"epoch", "value":"1420070400" "params":{ "mustRevalidate":true} |
ip-blacklist
Sets a space-separated list of IPs or CIDR blocks from which requests will be denied.
| Type(s)/Param(s) | Example Values |
|---|---|
| "name":"ip-blacklist", "value":"198.18.48.211" |
ip-whitelist
Denies requests all IPs except those IPs or CIDR blocks on the space-separated whitelist.
| Type(s)/Param(s) | Example Values |
|---|---|
| "name":"ip-whitelist", "value":"198.18.48.211" |
geo-blacklist
Sets a list of space-separated geographies from which requests will be denied. Regions should be paired with a country code, followed by a colon and then the region code, to prevent ambiguity. See Appendix B and C.
| Type(s)/Param(s) | Example Values |
|---|---|
| type: continent, country, region |
"name":"geo-blacklist", "type":"continent", "value":"EU" "type":"country", "value":"US" "type":"region", "value":"US:CA" |
geo-whitelist
Denies requests from all geographies except those on the space-separated whitelist. Regions should be paired with a country code to prevent ambiguity. See Appendix B and C.
| Type(s)/Param(s) | Example Values |
|---|---|
| type: continent, country, region |
"name":"geo-whitelist", "type":"continent", "value":"EU" "type":"country", "value":"US" "type":"region", "value":"US:CA" |
referer-blacklist
Sets space-separated Referer values that will result in denial of the request.
| Type(s)/Param(s) | Example Values |
|---|---|
| "name":"referer-blacklist","value":"http://my.disallowed-hostname.com/*" |
referer-whitelist
Sets allowed space-separated Referer values.
| Type(s)/Param(s) | Example Values |
|---|---|
| "name":"referer-whitelist","value":"http://my.allowed-hostname.com/*" |
modify-outgoing-request-path
Altering the request URI before it is sent to the origin server.
| Type(s)/Param(s) | Example Values |
|---|---|
| type: remove replace-all replace |
"name": "modify-outgoing-request-path", "type" : "replace", "value": "/dir1/dir2/###/dir3/dir4/" |
site-failover
Defines an alternate response to serve when the edge server cannot contact the origin server.
| Type(s)/Param(s) | Example Values |
|---|---|
| type: serve-301 serve-302 serve-alternate params: httpResponseStatus alternateHostname alternatePath preserveQueryString |
"name":"site-failover", "type":"serve-301", "params": { "httpResponseStatus": "404 500:504", "alternateHostname": "www.alternatehostname.com", "alternatePath": "/newdir1/newdir2", "preserveQueryString": true} |
downstream-caching
To control downstream caching of alternate content.
| Type(s)/Param(s) | Example Values |
|---|---|
| "name": "downstream-caching", "value":"no-store" |
token-auth
Defines rules for validating the authorization token on the edge server that allows access to the content.
| Type(s)/Param(s) | Example Values |
|---|---|
| params: tokenName tokenDelimiter tokenDelimiter aclDelimiter hmacAlgorithm escapeTokenInputs ignoreQueryString key transitionKey |
"name": "token-auth", "params": { "tokenName": "__mytoken__", "tokenDelimiter": "~", "aclDelimiter": "!", "hmacAlgorithm": "SHA256", "escapeTokenInputs": false, "ignoreQueryString": true, "key": "ffff", "transitionKey": "0000"} |