Download JSON Schema
Type: object
No Additional Properties

root tenant_id

the ID or IDs for a tenant to be used in logging

root tenant_idanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root tenant_idanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root tenant_idanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root lists
Type: object
named lists of values that can be referenced in match rules via {{list.}}

Each additional property must conform to the following schema

root listsadditionalProperties
Type: array of string
No Additional Items

Each item of this array must be:

root listsadditionalPropertiesadditionalProperties items
Type: string

root security_config

Security Configuration

Type: object
Specify risk group prefixes to Deny and any exceptions to those No Additional Properties

root security_configdeny_groups
Type: array
No Additional Items

Each item of this array must be:

root security_configdeny_groupsdeny_groups items

root security_configdeny_groupsdeny_groups itemsanyOfitem 0
Type: enum (of string)
Security event prefixes. Known prefixes include: • SQL-INJECTION-ANOMALY: Detects SQL injection attack attempts and suspicious database queries • XSS-ANOMALY: Identifies cross-site scripting vulnerabilities and malicious script injections • CMD-INJECTION-ANOMALY: Detects command injection attempts and unauthorized system commands • LFI-ANOMALY: Local file inclusion attacks attempting to access restricted files • RFI-ANOMALY: Remote file inclusion attacks trying to execute external malicious files • WAT-ANOMALY: Web application firewall anomalies and suspicious traffic patterns • PLATFORM-ANOMALY: Platform-specific security violations and configuration issues • POLICY-ANOMALY: Security policy violations and non-compliant access attempts • PROTOCOL-ANOMALY: Network protocol violations and malformed request patterns • BOT-BROWSER-IMPERSONATOR: Detects automated bots attempting to impersonate legitimate browsers • IPBLOCK-BURST: Monitors for sudden bursts of requests from blocked IP addresses • IPBLOCK-SUMMARY: Provides summary reports of IP blocking activities and statistics • REP: Reputation-based security alerts for known malicious sources Additional prefixes matching the pattern are also accepted.

Must be one of:

  • "SQL-INJECTION-ANOMALY"
  • "XSS-ANOMALY"
  • "CMD-INJECTION-ANOMALY"
  • "LFI-ANOMALY"
  • "RFI-ANOMALY"
  • "WAT-ANOMALY"
  • "PLATFORM-ANOMALY"
  • "POLICY-ANOMALY"
  • "PROTOCOL-ANOMALY"
  • "BOT-BROWSER-IMPERSONATOR"
  • "IPBLOCK-BURST"
  • "IPBLOCK-SUMMARY"
  • "REP"
root security_configdeny_groupsdeny_groups itemsanyOfitem 1
Type: string
Some groups are prefixes and may have additional identifiers appended to their values for more specific matchingMust match regular expression: ^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$

root security_configexceptions
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$
root security_configexceptionsexception
Type: object
You may add more specific properties that have these prefixes "IPBLOCK-BURST" "IPBLOCK-SUMMARY" "REP". Custom Rules (https://techdocs.akamai.com/application-security/reference/add-a-new-custom-rule-to-a-configuration) to be controlled by tenants by referencing the Custom Rule ID starting with the number six (6).No Additional Properties

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$paths
Type: array of string
list of path prefixes that can be excluded

Must contain a minimum of 1 items

Must contain a maximum of 50 items

No Additional Items

Each item of this array must be:

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$pathspaths items
Type: string
Must match regular expression: ^[/].*

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$rule_ids
Type: array of string
list of rule ids that can be excluded

Must contain a minimum of 1 items

Must contain a maximum of 50 items

No Additional Items

Each item of this array must be:

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$rule_idsrule_ids items
Type: string

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$v4_ips
Type: array of string
list of IPv4 CIDR or IPs that can be excluded

Must contain a minimum of 1 items

Must contain a maximum of 50 items

No Additional Items

Each item of this array must be:

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$v4_ipsv4_ips items
Type: string

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$v6_ips
Type: array of string
list of IPv4 CIDR or IPs that can be excluded

Must contain a minimum of 1 items

Must contain a maximum of 50 items

No Additional Items

Each item of this array must be:

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$v6_ipsv6_ips items
Type: string

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$asn
Type: array
list of Autonomous System (AS) numbers that can be excluded

Must contain a minimum of 1 items

Must contain a maximum of 50 items

No Additional Items

Each item of this array must be:

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$asnasn items

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$asnasn itemsanyOfitem 0
Type: integer

Value must be greater or equal to 1

root security_configexceptions^(IPBLOCK-BURST.|IPBLOCK-SUMMARY.|REP.|6[0-9]+).*$asnasn itemsanyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$

root delivery_config

Delivery Configuration

Type: object
Configure CDN delivery functionality No Additional Properties

root delivery_configversion
Type: enum (of string)

Must be one of:

  • "1.0"

root delivery_configonClientRequest
Type: object
This event happens for every request as the request is received, before checking if a response is available in cache. Use this event for request modifications before going to cache or to origin: https://techdocs.akamai.com/edgeworkers/docs/event-handler-functions#onclientrequest No Additional Properties

root delivery_configonClientRequestpm_variables
Type: object
feature flags for the most basic setup No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(?!PMUSER_)[A-Za-z0-9_]{1,22}$
root delivery_configonClientRequestpm_variables^(?!PMUSER_)[A-Za-z0-9_]{1,22}$

root delivery_configonClientRequestfeatures
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturestenantTag

root delivery_configonClientRequestfeaturestenantTaganyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturestenantTaganyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturestenantTaganyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturescaching
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturescachingrules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturescachingrulesrules itemsargs

root delivery_configonClientRequestfeaturescachingrulesrules itemsargsallOfitem 0
Type: object
caching feature options No Additional Properties

root delivery_configonClientRequestfeaturescachingrulesrules itemsargsallOfitem 0ttl_seconds
Type: integer
TTL in seconds

Value must be greater or equal to 0 and lesser or equal to 31536000

root delivery_configonClientRequestfeaturescachingrulesrules itemsargsallOfitem 1

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll
Type: object
All of these must match to executeNo Additional Properties

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllreqheader_wildcard_values
Type: object
matches map of request headers with wildcard support

Each additional property must conform to the following schema

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllreqheader_wildcard_valuesmatch_value_header
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllreqheader_wildcard_valuesadditionalPropertiesif
Type: string
Must match regular expression: ^\{\{list\..+\}\}$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllreqheader_wildcard_valuesadditionalPropertiesthen
Type: object
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllreqheader_wildcard_valuesadditionalPropertieselse
Type: array of string

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllreqheader_wildcard_valuesadditionalPropertieselseelse items
Type: string

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllquery_exists

matches map of query param keys

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllquery_existsanyOfitem 0
Type: array of string

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllquery_existsanyOfitem 0item 0 items
Type: string
Must match regular expression: ^[a-zA-Z0-9._-]+$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllquery_existsanyOfitem 1
Type: string
Must match regular expression: ^[a-zA-Z0-9._-]+$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllquery_existsanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!query_exists

does not match map of query param keys

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!query_existsanyOfitem 0
Type: array of string

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!query_existsanyOfitem 0item 0 items
Type: string
Must match regular expression: ^[a-zA-Z0-9._-]+$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!query_existsanyOfitem 1
Type: string
Must match regular expression: ^[a-zA-Z0-9._-]+$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!query_existsanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpaths
Type: object
matches list of paths

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpathsanyOfitem 0
Type: array

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpathsanyOfitem 0item 0 items
Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpathsanyOfitem 0item 0 itemsif
Type: string
Must match regular expression: ^\{\{list\..+\}\}$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpathsanyOfitem 0item 0 itemsthen
Type: object
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpathsanyOfitem 0item 0 itemselse
Type: string
Must match regular expression: ^[/].*
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpathsanyOfitem 1
Type: string
Must match regular expression: ^[/].*
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpathsanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpaths_wildcard
Type: object
matches list of paths with wildcards

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpaths_wildcardanyOfitem 0
Type: array of string

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpaths_wildcardanyOfitem 0item 0 items
Type: string
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpaths_wildcardanyOfitem 1
Type: string
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllpaths_wildcardanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllextension

matches list of file extensions

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!extension

does not match list of file extensions

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasn

matches list of Autonomous System (AS) numbers

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasnanyOfitem 0
Type: array

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasnanyOfitem 0item 0 items

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasnanyOfitem 0item 0 itemsanyOfitem 0
Type: integer

Value must be greater or equal to 1

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasnanyOfitem 0item 0 itemsanyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasnanyOfitem 1

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasnanyOfitem 1anyOfitem 0
Type: integer

Value must be greater or equal to 1

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasnanyOfitem 1anyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAllasnanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asn

does not match list of Autonomous System (AS) numbers

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asnanyOfitem 0
Type: array

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asnanyOfitem 0item 0 items

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asnanyOfitem 0item 0 itemsanyOfitem 0
Type: integer

Value must be greater or equal to 1

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asnanyOfitem 0item 0 itemsanyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asnanyOfitem 1

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asnanyOfitem 1anyOfitem 0
Type: integer

Value must be greater or equal to 1

root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asnanyOfitem 1anyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$
root delivery_configonClientRequestfeaturescachingrulesrules itemsmatchAll!asnanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientRequestfeaturescachingrulesrules itemstags

root delivery_configonClientRequestfeaturescachingrulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturescachingrulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturescachingrulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesdownstreamCaching

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules itemsargs
Type: object
Downstream caching options No Additional Properties

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules itemsargsbehavior
Type: enum (of string)
Specify what caching instructions edge servers send to the end user's client.

Must be one of:

  • "ALLOW"
  • "MUST_REVALIDATE"
  • "BUST"
  • "TUNNEL_ORIGIN"
  • "NONE"

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules itemsargsallow_behavior
Type: enum (of string)

Must be one of:

  • "LESSER"
  • "GREATER"
  • "REMAINING_LIFETIME"
  • "FROM_MAX_AGE"
  • "FROM_VALUE"
  • "PASS_ORIGIN"

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules itemsargsttl_seconds
Type: integer
Cache-control max-age value.

Value must be greater or equal to 0 and lesser or equal to 31536000

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules itemstags

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 0rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 1
Type: object
Downstream caching options No Additional Properties

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 1behavior
Type: enum (of string)
Specify what caching instructions edge servers send to the end user's client.

Must be one of:

  • "ALLOW"
  • "MUST_REVALIDATE"
  • "BUST"
  • "TUNNEL_ORIGIN"
  • "NONE"

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 1allow_behavior
Type: enum (of string)

Must be one of:

  • "LESSER"
  • "GREATER"
  • "REMAINING_LIFETIME"
  • "FROM_MAX_AGE"
  • "FROM_VALUE"
  • "PASS_ORIGIN"

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 1ttl_seconds
Type: integer
Cache-control max-age value.

Value must be greater or equal to 0 and lesser or equal to 31536000

root delivery_configonClientRequestfeaturesdownstreamCachinganyOfitem 1send_private
Type: boolean
Adds Private to the Cache-Control header.

root delivery_configonClientRequestfeaturesroute
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesrouterules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesrouterulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesrouterulesrules itemsargs
Type: object
route origin feature options No Additional Properties

root delivery_configonClientRequestfeaturesrouterulesrules itemsargspath
Type: string
modify forward pathMust match regular expression: ^[/].*

root delivery_configonClientRequestfeaturesrouterulesrules itemsargsorigin
Type: string Default: "default_eaas"
same as originId

root delivery_configonClientRequestfeaturesrouterulesrules itemsargsoriginId
Type: string Default: "default_eaas"
the origin id specified in pm configuration.

root delivery_configonClientRequestfeaturesrouterulesrules itemstags

root delivery_configonClientRequestfeaturesrouterulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesrouterulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesrouterulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesrouterulesrules itemspm_variables
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesrouterulesrules itemspm_variablesRT_ORIGIN_HOST_HEADER
Type: string
forward origin host header

Must be at most 500 characters long

root delivery_configonClientRequestfeaturesrouterulesrules itemspm_variablesRT_ORIGIN_DNS
Type: string
dns entry to use to connect to origin

Must be at most 500 characters long

root delivery_configonClientRequestfeaturesrouterulesrules itemspm_variablesORIGIN_CN
Type: string
if origin has a TLS certificate that does not contain the origin dns or forward host, specify the expected common name

Must be at most 500 characters long

root delivery_configonClientRequestfeaturesrespondWith
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesrespondWithrules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesrespondWithrulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemsargs
Type: object
respondWith options to construct responses from the edge No Additional Properties

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemsargsstatus
Type: integer
respondWith http status code

Value must be greater or equal to 200 and lesser or equal to 599

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemsargsheaders
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z][A-Za-z0-9!#$&'*+\-.^_`|~]*$
root delivery_configonClientRequestfeaturesrespondWithrulesrules itemsargsheaders^[A-Za-z][A-Za-z0-9!#$&'*+\-.^_`|~]*$
Type: array of string
response-header values as an array of strings

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemsargsheaders^[A-Za-z][A-Za-z0-9!#$&'*+\-.^_`|~]*$^[A-Za-z][A-Za-z0-9!#$&'*+\-.^_`|~]*$ items
Type: string
HTTP header value - printable ASCII and extended characters, no control characters except tabMust match regular expression: ^[\x09\x20-\x7E\x80-\xFF]*$

Must be at most 1000 characters long

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemsargsbody
Type: string
respondwith body

Must be at most 2048 characters long

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemstags

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesrespondWithrulesrules itemsmonitor_only
Type: boolean
Skips execution but adds tags to the log to help evaluate change's proposed execution

root delivery_configonClientRequestfeaturesredirect
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesredirectrules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesredirectrulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesredirectrulesrules itemsargs
Type: object
HTTP redirect No Additional Properties

root delivery_configonClientRequestfeaturesredirectrulesrules itemsargsstatus
Type: integer
301 or 302 redirect status code

Value must be greater or equal to 301 and lesser or equal to 302

root delivery_configonClientRequestfeaturesredirectrulesrules itemsargslocation
Type: string
redirect location. Supports template variables: {{scheme}}, {{host}}, {{path}}, {{query}}, {{?query}}
Examples:

"https://example.com/dashboard"

"/login"

"{{scheme}}://{{host}}/"

"https://{{host}}/{{path}}{{?query}}"

root delivery_configonClientRequestfeaturesredirectrulesrules itemstags

root delivery_configonClientRequestfeaturesredirectrulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesredirectrulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesredirectrulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesrewrite

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0rulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0rulesrules itemsargs
Type: object
Rewrite forward url. No Additional Properties

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0rulesrules itemsargsvalue
Type: string
Rewriten url. Supports variable interpolation.

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0rulesrules itemstags

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesrewriteanyOfitem 0rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesrewriteanyOfitem 1
Type: string
Rewriten url. Supports variable interpolation.

root delivery_configonClientRequestfeaturessetHeaders
Type: object

Each additional property must conform to the following schema

root delivery_configonClientRequestfeaturessetHeadersadditionalProperties

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 0
Type: string
HTTP header value - printable ASCII and extended characters, no control characters except tabMust match regular expression: ^[\x09\x20-\x7E\x80-\xFF]*$

Must be at most 1000 characters long

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 1
Type: null
root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 2
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 2rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemsargs
Type: object
set request headers going to origin. null values will remove the header No Additional Properties

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstags

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturessetVariable
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(?!PMUSER_)[A-Za-z0-9_]{1,22}$
root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$

root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 0
Type: string

Must be at most 500 characters long

root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstags

root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeaturesallowPost

root delivery_configonClientRequestfeaturesallowPostanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturesallowPostanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturesallowPostanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturesallowPut

root delivery_configonClientRequestfeaturesallowPutanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturesallowPutanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturesallowPutanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturesallowDelete

root delivery_configonClientRequestfeaturesallowDeleteanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturesallowDeleteanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturesallowDeleteanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturesallowPatch

root delivery_configonClientRequestfeaturesallowPatchanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturesallowPatchanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturesallowPatchanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeatureswebSockets

root delivery_configonClientRequestfeatureswebSocketsanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeatureswebSocketsanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeatureswebSocketsanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturestieredDistribution

root delivery_configonClientRequestfeaturestieredDistributionanyOfitem 0
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturestieredDistributionanyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturestieredDistributionanyOfitem 0rulesrules items
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturestieredDistributionanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturestieredDistributionanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturesoriginIpAcl

root delivery_configonClientRequestfeaturesoriginIpAclanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturesoriginIpAclanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturesoriginIpAclanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturesbreadcrumbs

root delivery_configonClientRequestfeaturesbreadcrumbsanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturesbreadcrumbsanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturesbreadcrumbsanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeatureschunkedTransferEncoding

root delivery_configonClientRequestfeatureschunkedTransferEncodinganyOfitem 0
Type: object
No Additional Properties

root delivery_configonClientRequestfeatureschunkedTransferEncodinganyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeatureschunkedTransferEncodinganyOfitem 0rulesrules items
Type: object
No Additional Properties
root delivery_configonClientRequestfeatureschunkedTransferEncodinganyOfitem 1
Type: boolean
root delivery_configonClientRequestfeatureschunkedTransferEncodinganyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturesremoveVary

root delivery_configonClientRequestfeaturesremoveVaryanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturesremoveVaryanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturesremoveVaryanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturescompression

root delivery_configonClientRequestfeaturescompressionanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientRequestfeaturescompressionanyOfitem 1
Type: boolean
root delivery_configonClientRequestfeaturescompressionanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientRequestfeaturesreadTimeout

root delivery_configonClientRequestfeaturesreadTimeoutanyOfitem 0
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesreadTimeoutanyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesreadTimeoutanyOfitem 0rulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesreadTimeoutanyOfitem 0rulesrules itemsargs
Type: object
Read timeout options No Additional Properties

root delivery_configonClientRequestfeaturesreadTimeoutanyOfitem 0rulesrules itemsargsvalue
Type: integer
Read timeout in milliseconds

Value must be greater or equal to 50 and lesser or equal to 120000

root delivery_configonClientRequestfeaturesreadTimeoutanyOfitem 1
Type: integer
Read timeout in milliseconds

Value must be greater or equal to 50 and lesser or equal to 120000

root delivery_configonClientRequestfeaturesfirstByteTimeout

root delivery_configonClientRequestfeaturesfirstByteTimeoutanyOfitem 0
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesfirstByteTimeoutanyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesfirstByteTimeoutanyOfitem 0rulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesfirstByteTimeoutanyOfitem 0rulesrules itemsargs
Type: object
First byte timeout options No Additional Properties

root delivery_configonClientRequestfeaturesfirstByteTimeoutanyOfitem 0rulesrules itemsargsvalue
Type: integer
First byte timeout in milliseconds

Value must be greater or equal to 50 and lesser or equal to 120000

root delivery_configonClientRequestfeaturesfirstByteTimeoutanyOfitem 1
Type: integer
First byte timeout in milliseconds

Value must be greater or equal to 50 and lesser or equal to 120000

root delivery_configonClientRequestfeaturesconnectTimeout

root delivery_configonClientRequestfeaturesconnectTimeoutanyOfitem 0
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesconnectTimeoutanyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeaturesconnectTimeoutanyOfitem 0rulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeaturesconnectTimeoutanyOfitem 0rulesrules itemsargs
Type: object
Connect timeout options No Additional Properties

root delivery_configonClientRequestfeaturesconnectTimeoutanyOfitem 0rulesrules itemsargsvalue
Type: integer
Connect timeout in milliseconds

Value must be greater or equal to 50 and lesser or equal to 120000

root delivery_configonClientRequestfeaturesconnectTimeoutanyOfitem 1
Type: integer
Connect timeout in milliseconds

Value must be greater or equal to 50 and lesser or equal to 120000

root delivery_configonClientRequestfeatureshsts

root delivery_configonClientRequestfeatureshstsanyOfitem 0
Type: object
No Additional Properties

root delivery_configonClientRequestfeatureshstsanyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeatureshstsanyOfitem 0rulesrules items
Type: object
No Additional Properties

root delivery_configonClientRequestfeatureshstsanyOfitem 0rulesrules itemsargs
Type: object
removeVary options No Additional Properties

root delivery_configonClientRequestfeatureshstsanyOfitem 0rulesrules itemstags

root delivery_configonClientRequestfeatureshstsanyOfitem 0rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeatureshstsanyOfitem 0rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientRequestfeatureshstsanyOfitem 0rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientRequestfeatureshstsanyOfitem 1
Type: object
removeVary options No Additional Properties

root delivery_configonClientRequestfeatureshstsanyOfitem 1maxAge
Type: integer
Expire time in seconds.

root delivery_configonClientRequestfeatureshstsanyOfitem 1preload
Type: boolean
Enable/disable HSTS preloading

root delivery_configonClientResponse
Type: object
This event happens before the response is sent to the client: https://techdocs.akamai.com/edgeworkers/docs/event-handler-functions#onclientresponse No Additional Properties

root delivery_configonClientResponsefeatures
Type: object
No Additional Properties

root delivery_configonClientResponsefeaturesrespondWith
Type: object
No Additional Properties

root delivery_configonClientResponsefeaturesrespondWithrules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules items
Type: object
No Additional Properties

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsargs
Type: object
respondWith options to construct responses from the edge No Additional Properties

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsargsstatus
Type: integer
respondWith http status code

Value must be greater or equal to 200 and lesser or equal to 599

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsargsheaders
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Za-z][A-Za-z0-9!#$&'*+\-.^_`|~]*$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsargsheaders^[A-Za-z][A-Za-z0-9!#$&'*+\-.^_`|~]*$
Type: array of string
response-header values as an array of strings

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsargsheaders^[A-Za-z][A-Za-z0-9!#$&'*+\-.^_`|~]*$^[A-Za-z][A-Za-z0-9!#$&'*+\-.^_`|~]*$ items
Type: string
HTTP header value - printable ASCII and extended characters, no control characters except tabMust match regular expression: ^[\x09\x20-\x7E\x80-\xFF]*$

Must be at most 1000 characters long

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsargsbody
Type: string
respondwith body

Must be at most 2048 characters long

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll
Type: object
All of these must match to executeNo Additional Properties

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllquery_exists

matches map of query param keys

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllquery_existsanyOfitem 0
Type: array of string

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllquery_existsanyOfitem 0item 0 items
Type: string
Must match regular expression: ^[a-zA-Z0-9._-]+$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllquery_existsanyOfitem 1
Type: string
Must match regular expression: ^[a-zA-Z0-9._-]+$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllquery_existsanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!query_exists

does not match map of query param keys

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!query_existsanyOfitem 0
Type: array of string

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!query_existsanyOfitem 0item 0 items
Type: string
Must match regular expression: ^[a-zA-Z0-9._-]+$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!query_existsanyOfitem 1
Type: string
Must match regular expression: ^[a-zA-Z0-9._-]+$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!query_existsanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllextension

matches list of file extensions

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!extension

does not match list of file extensions

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasn

matches list of Autonomous System (AS) numbers

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasnanyOfitem 0
Type: array

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasnanyOfitem 0item 0 items

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasnanyOfitem 0item 0 itemsanyOfitem 0
Type: integer

Value must be greater or equal to 1

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasnanyOfitem 0item 0 itemsanyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasnanyOfitem 1

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasnanyOfitem 1anyOfitem 0
Type: integer

Value must be greater or equal to 1

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasnanyOfitem 1anyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllasnanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asn

does not match list of Autonomous System (AS) numbers

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asnanyOfitem 0
Type: array

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asnanyOfitem 0item 0 items

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asnanyOfitem 0item 0 itemsanyOfitem 0
Type: integer

Value must be greater or equal to 1

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asnanyOfitem 0item 0 itemsanyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asnanyOfitem 1

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asnanyOfitem 1anyOfitem 0
Type: integer

Value must be greater or equal to 1

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asnanyOfitem 1anyOfitem 1
Type: string
represented as only as an integer without AS prefixMust match regular expression: ^[1-9]\d*$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!asnanyOfitem 2
Type: string
reference to a list defined in the tenant or common config, e.g. {{list.blocked_ips}}Must match regular expression: ^\{\{list\..+\}\}$

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllstatus
Type: array
list of status codes

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllstatusstatus items

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllstatusstatus itemsoneOfitem 0
Type: integer
Status code as integer

Value must be greater or equal to 100 and lesser or equal to 599

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllstatusstatus itemsoneOfitem 1
Type: string
Range of status codes in the format "200-299". Match is inclusive.Must match regular expression: ^\d{3}-\d{3}$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAllstatusstatus itemsoneOfitem 2
Type: string
Class of status codes in the format "4xx", "5xx" etc.Must match regular expression: ^\d{1}[xX][xX]$

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!status
Type: array
list of status codes

Must contain a minimum of 1 items

Must contain a maximum of 100 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!status!status items

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!status!status itemsoneOfitem 0
Type: integer
Status code as integer

Value must be greater or equal to 100 and lesser or equal to 599

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!status!status itemsoneOfitem 1
Type: string
Range of status codes in the format "200-299". Match is inclusive.Must match regular expression: ^\d{3}-\d{3}$
root delivery_configonClientResponsefeaturesrespondWithrulesrules itemsmatchAll!status!status itemsoneOfitem 2
Type: string
Class of status codes in the format "4xx", "5xx" etc.Must match regular expression: ^\d{1}[xX][xX]$

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemstags

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturesrespondWithrulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientResponsefeaturescompression

root delivery_configonClientResponsefeaturescompressionanyOfitem 0
Type: object
No Additional Properties
root delivery_configonClientResponsefeaturescompressionanyOfitem 1
Type: boolean
root delivery_configonClientResponsefeaturescompressionanyOfitem 2
Type: string
Must match regular expression: true|false

root delivery_configonClientResponsefeaturessetHeaders
Type: object

Each additional property must conform to the following schema

root delivery_configonClientResponsefeaturessetHeadersadditionalProperties

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 0
Type: string
HTTP header value - printable ASCII and extended characters, no control characters except tabMust match regular expression: ^[\x09\x20-\x7E\x80-\xFF]*$

Must be at most 1000 characters long

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 1
Type: null
root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2
Type: object
No Additional Properties

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules items
Type: object
No Additional Properties

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemsargs
Type: object
set response headers going to client from edge. null values will remove the header No Additional Properties

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstags

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientResponsefeaturessetVariable
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(?!PMUSER_)[A-Za-z0-9_]{1,22}$
root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$

root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 0
Type: string

Must be at most 500 characters long

root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 1
Type: boolean
root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2
Type: object
No Additional Properties

root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules items
Type: object
No Additional Properties

root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstags

root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonClientResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonOriginResponse
Type: object
This event happens as the origin response is created. The event only happens if the response is not served from cache and not constructed on the edge. Use this event if you want to modify the response before it is cached: https://techdocs.akamai.com/edgeworkers/docs/event-handler-functions#onoriginresponse No Additional Properties

root delivery_configonOriginResponsefeatures
Type: object
No Additional Properties

root delivery_configonOriginResponsefeaturescacheTag

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0
Type: object
No Additional Properties

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules items
Type: object
No Additional Properties

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules itemsargs
Type: object
Manage Cache Tags from the Edge and Origin No Additional Properties

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules itemsargsprefix
Type: string
Must match regular expression: [a-zA-Z0-9_-]+

Must be at most 25 characters long

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules itemsargshonorOriginSurrogateKey
Type: boolean Default: false
Merge tags from first Surrogate-Key header returned by origin

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules itemsargscreateDomainTag
Type: boolean Default: true
Create a cache tag with the request host and prefix if one is defined

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules itemsargscreatePathTag
Type: boolean Default: false
Create a cache tag with the request path and prefix if one is defined

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules itemsargscreateDomainAndPathTag
Type: boolean Default: false
Create a cache tag with the request path and prefix if one is defined

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules itemsargsedgeCacheTags
Type: array of string
List of Edge-Cache-Tag tags to set at the edge

Must contain a minimum of 1 items

Must contain a maximum of 128 items

No Additional Items

Each item of this array must be:

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 0rulesrules itemsargsedgeCacheTagsedgeCacheTags items
Type: string
Must match regular expression: [a-zA-Z0-9&'^$!`#%.+~_|/-]+

Must be at most 128 characters long

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 1
Type: object
Manage Cache Tags from the Edge and Origin No Additional Properties

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 1prefix
Type: string
Must match regular expression: [a-zA-Z0-9_-]+

Must be at most 25 characters long

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 1honorOriginSurrogateKey
Type: boolean Default: false
Merge tags from first Surrogate-Key header returned by origin

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 1createDomainTag
Type: boolean Default: true
Create a cache tag with the request host and prefix if one is defined

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 1createPathTag
Type: boolean Default: false
Create a cache tag with the request path and prefix if one is defined

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 1createDomainAndPathTag
Type: boolean Default: false
Create a cache tag with the request path and prefix if one is defined

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 1edgeCacheTags
Type: array of string
List of Edge-Cache-Tag tags to set at the edge

Must contain a minimum of 1 items

Must contain a maximum of 128 items

No Additional Items

Each item of this array must be:

root delivery_configonOriginResponsefeaturescacheTaganyOfitem 1edgeCacheTagsedgeCacheTags items
Type: string
Must match regular expression: [a-zA-Z0-9&'^$!`#%.+~_|/-]+

Must be at most 128 characters long

root delivery_configonOriginResponsefeaturessetHeaders
Type: object

Each additional property must conform to the following schema

root delivery_configonOriginResponsefeaturessetHeadersadditionalProperties

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 0
Type: string
HTTP header value - printable ASCII and extended characters, no control characters except tabMust match regular expression: ^[\x09\x20-\x7E\x80-\xFF]*$

Must be at most 1000 characters long

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 1
Type: null
root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2
Type: object
No Additional Properties

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules items
Type: object
No Additional Properties

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemsargs
Type: object
set response headers going into edge from origin. null values will remove the header No Additional Properties

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstags

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonOriginResponsefeaturessetHeadersadditionalPropertiesanyOfitem 2rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonOriginResponsefeaturessetVariable
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(?!PMUSER_)[A-Za-z0-9_]{1,22}$
root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$

root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 0
Type: string

Must be at most 500 characters long

root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 1
Type: boolean
root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2
Type: object
No Additional Properties

root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rules
Type: array of object
A list of rules for this feature. The first match winsNo Additional Items

Each item of this array must be:

root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules items
Type: object
No Additional Properties

root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstags

root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 0
Type: string
a single tag to make visible in datastream logs when matched condition is trueMust match regular expression: ^[^|,]+$

Must be at most 20 characters long

root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 1
Type: array of string
list of tags to make visible in datastream logs when matched condition is true

Must contain a minimum of 1 items

Must contain a maximum of 5 items

No Additional Items

Each item of this array must be:

root delivery_configonOriginResponsefeaturessetVariable^(?!PMUSER_)[A-Za-z0-9_]{1,22}$anyOfitem 2rulesrules itemstagsanyOfitem 1item 1 items
Type: string
Must match regular expression: ^[^|,]+$

Must be at most 20 characters long