• source (string): With enablePreconnect or enablePush on, specifies the type of data that anticipates optimal connections. If you specify a value of Real User Monitoring, make sure to enable the corresponding realUserMonitoring behavior. If you specify mPulse, enable the mPulse behavior.

• enablePush (boolean): Enables adaptive acceleration’s HTTP/2 server push feature.

• enablePreconnect (boolean): When enabled, allows browsers to open TCP connections to web pages before making requests.

• preloadEnable (boolean): With the beacon source set to mPulse, allows fonts to preload.

• enableRo (boolean): Enables the Resource Optimizer, which compresses common file components such as scripts, fonts, and CSS, and caches them on the Akamai network.

• compressMobile (boolean): When enabled, adapts images served over cellular mobile networks.

• compressStandard (boolean): When enabled, adapts images served over non-cellular networks.

• tier1StandardCompressionMethod (enum string): Specifies tier–1 non-cellular network behavior, either COMPRESS, STRIP, or BYPASS.

• tier1StandardCompressionValue (number within 0–100 range): With tier1StandardCompressionMethod set to COMPRESS, this specifies the compression percentage.

• tier2StandardCompressionMethod (enum string): Specifies tier–2 non-cellular network behavior, either COMPRESS, STRIP, or BYPASS.

• tier2StandardCompressionValue (number within 0–100 range): With tier2StandardCompressionMethod set to COMPRESS, this specifies the compression percentage.

• tier3StandardCompressionMethod (enum string): Specifies tier–5 non-cellular network behavior, either COMPRESS, STRIP, or BYPASS.

• tier3StandardCompressionValue (number within 0–100 range): With tier3StandardCompressionMethod set to COMPRESS, this specifies the compression percentage.

• tier1MobileCompressionMethod (enum string): Specifies tier–1 behavior, either COMPRESS, STRIP, or BYPASS.

• tier1MobileCompressionValue (number within 0–100 range): With tier1MobileCompressionMethod set to COMPRESS, this specifies the compression percentage.

• tier2MobileCompressionMethod (enum string): Specifies tier–2 cellular-network behavior, either COMPRESS, STRIP, or BYPASS.

• tier2MobileCompressionValue (number within 0–100 range): With tier2MobileCompressionMethod set to COMPRESS, this specifies the compression percentage.

• tier3MobileCompressionMethod (enum string): Specifies tier–5 cellular-network behavior, either COMPRESS, STRIP, or BYPASS.

• tier3MobileCompressionValue (number within 0–100 range): With tier3MobileCompressionMethod set to COMPRESS, this specifies the compression percentage.

• description (string): Human-readable description of what the XML block does.

• xml (string): Akamai XML metadata.

• enabled (boolean): Enables aggregated reporting.

• reportName (string): The unique name of the aggregated report within the property. If you reconfigure any attributes or variables in the aggregated reporting behavior, update this field to a unique value to enable logging data in a new instance of the report.

• attributesCount (number within 1–4 range): Select the number of attributes by which your report is grouped. You can add up to four attributes.

• attribute1 (string; allows variables): Select a previously user-defined variable to be an attribute for the report. The values extracted for all attributes range from 0 to 20 characters.

• attribute2 (string; allows variables): Select a previously user-defined variable to be an attribute for the report. The values extracted for all attributes range from 0 to 20 characters.

• attribute3 (string; allows variables): Select a previously user-defined variable to be an attribute for the report. The values extracted for all attributes range from 0 to 20 characters.

• attribute4 (string; allows variables): Select a previously user-defined variable to be an attribute for the report. The values extracted for all attributes range from 0 to 20 characters.

• enabled (boolean): Enables the Akamaizer behavior.

• matchHostname (string): Specifies the hostname to match on as a Perl-compatible regular expression.

• replacementHostname (string): Specifies the replacement hostname for the tag to use.

• scope (enum string): Specifies the part of HTML content the tagsAttribute refers to:

  • ATTRIBUTE for when tagsAttribute refers to a tag/attribute pair, the match only applies to the attribute.
  • URL_ATTRIBUTE is the same as ATTRIBUTE, but applies when the attribute value is a URL. In that case, it converts to an absolute URL prior to substitution.
  • BLOCK substitutes within the tag’s contents, but not within any nested tags.
  • PAGE ignores the tagsAttribute field and performs the substitution on the entire page.

• tagsAttribute (enum string): Specifies the tag or tag/attribute combination to operate on, any of the following:

A
A_HREF
AREA
AREA_HREF
BASE
BASE_HREF
FORM
FORM_ACTION
IFRAME
IFRAME_SRC
IMG
IMG_SRC
LINK
LINK_HREF
SCRIPT
SCRIPT_SRC
TABLE
TABLE_BACKGROUND
TD
TD_BACKGROUND

• replaceAll (boolean): Replaces all matches when enabled, otherwise replaces only the first match.

• includeTagsAttribute (boolean): Whether to include the tagsAttribute value.

• enabled (boolean): Enables all HTTP requests for parent servers in the cache hierarchy.

• enabled (boolean): Allows you to assign custom origin definitions referenced in sub-rules by cloudletsOrigin labels. If disabled, all sub-rules are ignored.

• honorBaseDirectory (boolean): If enabled, prefixes any Cloudlet-generated origin path with a path defined by an Origin Base Path behavior. If no path is defined, it has no effect. If another Cloudlet policy already prepends the same Origin Base Path, the path is not duplicated.

• purgeOriginQueryParameter (string): When purging content from a Cloudlets Origin, this specifies a query parameter name whose value is the specific named origin to purge. Note that this only applies to content purge requests, for example when using the Fast Purge API.

• enabled (boolean): When enabled, allows DELETE requests. Content does not cache.

• allowBody (boolean): When enabled, allows data in the body of the DELETE request.

• enabled (boolean): Enables HTTPS cache key sharing.

• enabled (boolean): Downgrades to HTTP protocol for the origin server.

• enabled (boolean): When enabled, allows OPTIONS requests. Content does not cache.

• enabled (boolean): When enabled, allows PATCH requests. Content does not cache.

• enabled (boolean): When enabled, allows POST requests.

• allowWithoutContentLength (boolean): By default, POST requests also require a Content-Length header, or they result in a 411 error. With this option enabled with no specified Content-Length, the edge server relies on a Transfer-Encoding header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a 0 value to the forward request.

• enabled (boolean): When enabled, allows PUT requests. Content does not cache.

• enabled (boolean): Allows Chunked Transfer Encoding requests.

• enabled (boolean): Activates the API Prioritization feature.

• cloudletPolicy (object): Identifies the Cloudlet policy in an object featuring unique numeric id and descriptive string name members.

• label (string): A label to distinguish this API Prioritization policy from any others in the same property.

• useThrottledCpCode (boolean): Specifies whether to apply an alternative CP code for requests served the alternate response.

• throttledCpCode (object): With useThrottledCpCode enabled, this specifies the CP code as an object:

  "throttledCpCode": {
      "id"   : 12345,
      "name" : "sent to waiting room"
  }
  

• useThrottledStatusCode (boolean): When enabled, allows you to assign a specific HTTP response code to a throttled request.

• throttledStatusCode (number): With change_response_code enabled, specifies the HTTP response code for requests that receive the alternate response.

• netStorage (object): Specify the NetStorage domain that contains the alternate response. For example:

  "netStorage": {
      "id"                 : "netstorage_id",
      "name"               : "Waiting Room",
      "downloadDomainName" : "example.wait.akamai.com",
      "cpCode"             : 12345
  }
  

• netStoragePath (string): Specify the full NetStorage path for the alternate response, including trailing file name.

• alternateResponseCacheTtl (number within 5–30 range): Specifies the alternate response’s time to live in the cache, 5 minutes by default.

• enabled (boolean): Activates the Application Load Balancer Cloudlet.

• cloudletPolicy (object): Identifies the Cloudlet policy in an object featuring unique numeric id and descriptive string name members.

• label (string): A label to distinguish this Application Load Balancer policy from any others within the same property.

• stickinessCookieType (enum string): Determines how a cookie persistently associates the client with a load-balanced origin. Specify an overall DURATION or a FIXED_DATE for when the cookie expires. Specify ON_BROWSER_CLOSE to limit the cookie duration to browser sessions, or to when the ORIGIN_SESSION terminates. (After the cookie expires, the cookie type re-evaluates.) To preserve the cookie indefinitely, specify NEVER. To dynamically reassign different load-balanced origins for each request, specify NONE.

• stickinessExpirationDate (ISO 8601 format date/time string): With stickinessCookieType set to FIXED_DATE, this specifies when the cookie expires.

• stickinessDuration (duration string): With stickinessCookieType set to DURATION, sets how long it is before the cookie expires.

• stickinessRefresh (boolean): With stickinessCookieType set to DURATION, enabling this extends the duration of the cookie with each new request. When enabled, the DURATION thus specifies the latency between requests that would cause the cookie to expire.

• originCookieName (string): Specifies the name for your session cookie.

• specifyStickinessCookieDomain (boolean): Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.

• stickinessCookieDomain (string): With specifyStickinessCookieDomain enabled, specifies the domain to track the stickiness cookie.

• stickinessCookieAutomaticSalt (boolean): Sets whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable this if sharing the population cookie across more than one property.

• stickinessCookieSalt (string): With stickinessCookieAutomaticSalt disabled, specifies the stickiness cookie’s salt value. Use this option to share the cookie across many properties.

• stickinessCookieSetHttpOnlyFlag (boolean): Ensures the cookie is transmitted only over HTTP.

• stickinessCookieSetSecureFlag (boolean): Deploys the stickiness cookie as secure.

• allDownNetStorage (object): Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available. This example shows the object’s structure:

  "allDownNetStorage": {
      "id"                 : "uniq_id",
      "name"               : "Download Area",
      "downloadDomainName" : "download.example.akamai.com",
      "cpCode"             : 12345
  }
  

• allDownNetStorageFile (string): Specifies the fallback maintenance page’s filename, expressed as a full path from the root of the NetStorage server.

• allDownStatusCode (string): Specifies the HTTP response code when all load-balancing origins are unavailable.

• failoverStatusCodes (array of string values): Specifies a set of HTTP status codes that signal a failure on the origin, in which case the cookie that binds the client to that origin is invalidated and the client is rerouted to another available origin.

• failoverMode (enum string): Determines what to do if an origin fails. If set to AUTOMATIC, automatically determines which origin in the policy to try next. If set to MANUAL, you define a sequence of failover origins. (If failover runs out of origins, requests are sent to NetStorage.) Setting DISABLED turns off failover, but maintains origin stickiness even when the origin goes down.

• failoverOriginMap (array): With failoverMode set to MANUAL, this specifies a fixed set of failover mapping rules. If the origin identified by fromOriginId fails, requests stuck to that origin retry for each alternate origin toOriginIds specifies, until one succeeds:

  "failoverOriginMap" : [
      {
          "fromOriginId": "origin1",
          "toOriginIds": [ "origin2", "origin3" ]
      }
  ]
  

• failoverAttemptsThreshold (number): Sets the number of failed requests that would trigger the failover process.

• allowCachePrefresh (boolean): When enabled, allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.

• enabled (boolean): Enables the Audience Segmentation cloudlet feature.

• cloudletPolicy (object): Identifies the Cloudlet policy in an object featuring unique numeric id and descriptive string name members.

• label (string): Specifies a suffix to append to the cookie name. This helps distinguish this audience segmentation policy from any others within the same property.

• segmentTrackingMethod (enum string): Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request either IN_COOKIE_HEADER, IN_QUERY_PARAM, IN_CUSTOM_HEADER, or the default, NONE.

• segmentTrackingQueryParam (string): With segmentTrackingMethod set to IN_QUERY_PARAM, this query parameter specifies the name of the segmentation rule.

• segmentTrackingCookieName (string): With segmentTrackingMethod set to IN_COOKIE_HEADER, this cookie name specifies the name of the segmentation rule.

• segmentTrackingCustomHeader (string): With segmentTrackingMethod set to IN_CUSTOM_HEADER, this custom HTTP header specifies the name of the segmentation rule.

• populationCookieType (enum string): Specifies when the segmentation cookie expires, either ON_BROWSER_CLOSE, NEVER, or based on a specific DURATION.

• populationDuration (duration string): With populationCookieType set to DURATION, specifies the lifetime of the segmentation cookie.

• populationRefresh (boolean): If disabled, sets the expiration time only if the cookie is not yet present in the request.

• specifyPopulationCookieDomain (boolean): Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.

• populationCookieDomain (string): With specifyPopulationCookieDomain enabled, specifies the domain to track the population cookie.

• populationCookieAutomaticSalt (boolean): Whether to assign a salt value automatically to the cookie to prevent manipulation by the user. You should not enable if sharing the population cookie across more than one property.

• populationCookieSalt (string): With populationCookieAutomaticSalt disabled, specifies the cookie’s salt value. Use this option to share the cookie across many properties.

• populationCookieIncludeRuleName (boolean): When enabled, includes in the session cookie the name of the rule in which this behavior appears.

• value (string; allows variables): Specifies the base path of content on your origin server. The value must begin and end with a slash (/) character, for example /parent/child/.

• enabled (boolean): Enable diagnostic data beacons.

• cpcodes (string): The space-separated list of CP codes that trigger the beacons. You need to specify the same set of CP codes within BOSS.

• requestType (enum string): Specify whether to trigger a beacon for EDGE requests only, or EDGE_MIDGRESS to include midgress requests.

• forwardType (enum string): Specify whether to trigger a beacon for internal MIDGRESS forwards only, ORIGIN forwards only, or MIDGRESS_ORIGIN for both.

• samplingFrequency (enum string): Specifies SAMPLING_FREQ_0_1 as a sampling frequency, or SAMPLING_FREQ_0_0 to disable beacons altogether.

• conditionalSamplingFrequency (enum string): Specifies either CONDITIONAL_SAMPLING_FREQ_0_1, CONDITIONAL_SAMPLING_FREQ_0_2, CONDITIONAL_SAMPLING_FREQ_0_3, or CONDITIONAL_SAMPLING_FREQ_0_0 to disable beacons altogether.

• conditionalHTTPStatus (array of string values): Specifies the set of response status codes or ranges that trigger the beacon. You can combine any of these values: 0xx, 302, 304, 3xx, 401, 403, 404, 408, 4xx, 500, 503, 5xx, 6xx.

• conditionalErrorPattern (string): A space-separated set of error patterns that trigger beacons to conditional feeds. Each pattern can include wildcards, such as *CONNECT* *DENIED*.

• enabled (boolean): Enables the break connection behavior.

• enabled (boolean): Enables Brotli compression.

• enabled (boolean): When enabled, activates the error-caching behavior.

• ttl (duration string): Overrides the default caching duration of 10s. Note that if set to 0, it is equivalent to no-cache, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of 500.

• preserveStale (boolean): When enabled, the edge server preserves stale cached objects when the origin returns 400, 500, 502, 503, and 504 error codes. This avoids re-fetching and re-caching content after transient errors.

• rule (enum string): Specifies how to modify the cache ID:

  • INCLUDE_HEADERS includes specified HTTP headers in the cache ID.
  • INCLUDE_COOKIES includes specified cookies in the cache ID.
  • INCLUDE_ALL_QUERY_PARAMS includes all query parameters when forming a cache ID.
  • INCLUDE_QUERY_PARAMS includes the specified set of query parameters when forming a cache ID.
  • EXCLUDE_QUERY_PARAMS excludes the specified set of query parameters when forming a cache ID.
  • INCLUDE_VARIABLE includes a specific user variable in the cache ID.
  • INCLUDE_URL includes the full URL, the same as the default without the cacheid behavior.

• includeValue (boolean): When enabled, includes the value of the specified elements in the cache ID. Otherwise only their names are included.

• optional (boolean): When enabled, requires the behavior’s specified elements to be present for content to cache. When disabled, requests that lack the specified elements are still cached. This option only applies when the type is INCLUDE_COOKIES, INCLUDE_QUERY_PARAMS, INCLUDE_HEADERS, or EXCLUDE_QUERY_PARAMS.

• elements (array of string values): Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID. This only applies when the rule is INCLUDE_COOKIES, INCLUDE_HEADERS, INCLUDE_QUERY_PARAMS, or EXCLUDE_QUERY_PARAMS.

• variableName (string): With rule set to INCLUDE_VARIABLE, specifies the name of the variable you want to include in the cache key.

• enabled (boolean): When enabled, ignores case when forming cache keys.

• behavior (enum string): Configures how sets of query string parameters translate to cache keys:

  • IGNORE_ALL causes query string parameters to be ignored when forming cache keys.
  • IGNORE or INCLUDE makes the key depend on the sequence of values in the parameters field.
  • INCLUDE_ALL_PRESERVE_ORDER forms a separate key for the entire set of query parameters, but sensitive to the order in which they appear. (For example, ?q=akamai&state=ma and ?state=ma&q=akamai cache separately.)
  • INCLUDE_ALL_ALPHABETIZE_ORDER forms keys for the entire set of parameters, but the order doesn’t matter. The examples above both use the same cache key.

  Be careful when applying behavior not to ignore any parameters that result in substantially different content, as it is not reflected in the cached object.

• parameters (array of string values): With behavior set to INCLUDE or IGNORE, parameters specifies the set of parameter field names to include in or exclude from the cache key. By default, these match the field names as string prefixes.

• exactMatch (boolean): When enabled, parameters must match exactly. Keep disabled to match string prefixes.

• purgeKey (string): Specifies the new cache key path as an alphanumeric value.

• enabled (boolean): Enables caching of POST responses.

• useBody (enum string): Define how and whether to use the POST message body as a cache key:

  • IGNORE uses only the URL to cache the response.
  • MD5 adds a string digest of the data as a query parameter to the cache URL.
  • QUERY adds the raw request body as a query parameter to the cache key, but only if the POST request’s Content-Type is application/x-www-form-urlencoded. (Use this in conjunction with cacheId to define relevant query parameters.)

• enabled (boolean): Enables the redirect caching behavior.

• behavior (enum string): Specify ALWAYS to include the Edge-Cache-Tag header in all responses. Specify NEVER to match edge servers’ default response, stripping out the header. Otherwise if you specify PRAGMA_HEADER, edge servers respond with the Edge-Cache-Tag header only when you pass in a Pragma: akamai-x-get-cache-tags header as part of the request.

• behavior (enum string): Specify the caching option:

  • NO_STORE clears the cache and serves from the origin.
  • BYPASS_CACHE retains the cache but serves from the origin.
  • Honor the origin’s MAX_AGE header
  • Honor the origin’s CACHE_CONTROL header
  • Honor the origin’s EXPIRES header
  • Honor CACHE_CONTROL_AND_EXPIRES the origin’s CACHE_CONTROL or EXPIRES header, whichever comes last.

  Note. New CACHE_CONTROL_BETA and CACHE_CONTROL_AND_EXPIRES_BETA values add support for the s-maxage response directive specified in RFC 7234. Use these alternative values to instruct a downstream CDN how long to cache content.

• mustRevalidate (boolean): Determines what to do once the cached content has expired, by which time the Akamai platform should have re-fetched and validated content from the origin. If enabled, only allows the re-fetched content to be served. If disabled, may serve stale content if the origin is unavailable.

• ttl (duration string): The maximum time content may remain cached. Setting the value to 0 is the same as setting a no-cache header, which forces content to revalidate.

• defaultTtl (duration string): Set the MAX_AGE header for the cached content.

• honorPrivateEnabled (boolean): With the behavior set to either CACHE_CONTROL or CACHE_CONTROL_AND_EXPIRES, enabling this instructs edge servers to honor Cache-Control: private headers.

• honorMustrevalidateEnabled (boolean): With the behavior set to either CACHE_CONTROL or CACHE_CONTROL_AND_EXPIRES, enabling this instructs edge servers to honor Cache-Control: must-revalidate headers.

• enabled (boolean): Enables the centralized authorization behavior.

• enabled (boolean): When enabled, allows edge servers to chase redirects.

• limit (string): Specifies, as a string, the maximum number of redirects to follow.

• serve404 (boolean): Once the redirect limit is reached, enabling this option serves an HTTP 404 (Not Found) error instead of the last redirect.

• country (enum string): Specifies the client request’s geographic region, or UNKNOWN to defer any optimizations based on geography. Possible global regions are GLOBAL, GLOBAL_ASIA_CENTRIC, GLOBAL_EU_CENTRIC, or GLOBAL_US_CENTRIC. More specific regions include ASIA_PACIFIC, AUSTRALIA, EUROPE, GERMANY, INDIA, ITALY, JAPAN, NORDICS, NORTH_AMERICA, SOUTH_AMERICA, TAIWAN, or UNITED_KINGDOM. Specify OTHER as a fallback value.

• enabled (boolean): When enabled, serves the custom response.

• body (string; allows variables): HTML response of up to 2000 characters to send to the end-user client.

• responseCode (numeric enum): The HTTP response code to send to the end-user client, either 200, 401, 403, 404, 405, 500, 501, 502, 503, or 504.

• forceEviction (boolean): When enabled, removes the underlying object from the cache, since it is not being served.

• objectSize (enum string): Optimize based on the size of the object retrieved from the origin, either LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, or UNKNOWN to defer this optimization. Specify OTHER as a fallback value.

• popularityDistribution (enum string): Optimize based on the content’s expected popularity, either ALL_POPULAR for a high volume of requests over a short period, LONG_TAIL for a low volume of requests over a long period, or UNKNOWN to defer this optimization. Specify OTHER as a fallback value.

• catalogSize (enum string): Optimize based on the total size of the content library delivered, either SMALL (under 100GB), MEDIUM (100GB–1TB), LARGE (1TB–100TB), EXTRA_LARGE (more than 100TB), or UNKNOWN to defer this optimization. Specify OTHER as a fallback value.

• contentType (enum string): Optimize based on the type of content, either SOFTWARE, IMAGES, WEB_OBJECTS (generally, media delivered for websites), USER_GENERATED (generally, user-generated media), OTHER_OBJECTS for content that doesn’t fall under any of these categories, or UNKNOWN, to defer this optimization.

• catalogSize (enum string): Optimize based on the total size of the content library delivered, either SMALL (under 100GB), MEDIUM (100GB–1TB), LARGE (1TB–100TB), EXTRA_LARGE (more than 100TB), or UNKNOWN to defer this optimization. Specify OTHER to customize the value.

• contentType (enum string): Optimize based on the quality of media content, either SD (standard definition), HD (high definition), ULTRA_HD, OTHER for more than one level of quality, or UNKNOWN to defer this optimization.

• popularityDistribution (enum string): Optimize based on the content’s expected popularity, either ALL_POPULAR for a high volume of requests over a short period, LONG_TAIL for a low volume of requests over a long period, or UNKNOWN to defer this optimization. Specify OTHER to customize the value.

• hls (boolean): Enable delivery of HLS media.

• segmentDurationHLS (enum string): With the hls option enabled, specifies the duration of individual segments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S. Specify OTHER to customize the value.

• segmentDurationHLSCustom (number): With segmentDurationHLS set to OTHER, customizes the number of seconds for the segment.

• segmentSizeHLS (enum string): With the hls option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• hds (boolean): Enable delivery of HDS media.

• segmentDurationHDS (enum string): With the hds option enabled, specifies the duration of individual fragments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S. Specify OTHER to customize the value.

• segmentDurationHDSCustom (number): With segmentDurationHDS set to OTHER, customizes the number of seconds for the fragment.

• segmentSizeHDS (enum string): With the hds option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• dash (boolean): Enable delivery of DASH media.

• segmentDurationDASH (enum string): With the dash option enabled, specifies the duration of individual segments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S. Specify OTHER to customize the value.

• segmentDurationDASHCustom (number): With segmentDurationDASH set to OTHER, customizes the number of seconds for the segment.

• segmentSizeDASH (enum string): With the dash option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• smooth (boolean): Enable delivery of Smooth media.

• segmentDurationSmooth (enum string): With the smooth option enabled, specifies the duration of individual fragments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S. Specify OTHER to customize the value.

• segmentDurationSmoothCustom (number): With segmentDurationSmooth set to OTHER, customizes the number of seconds for the fragment.

• segmentSizeSmooth (enum string): With the smooth option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• objectSize (enum string): Optimize based on the size of the object retrieved from the origin, either LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, or UNKNOWN to defer this optimization. Specify OTHER as a fallback value.

• popularityDistribution (enum string): Optimize based on the content’s expected popularity, either ALL_POPULAR for a high volume of requests over a short period, LONG_TAIL for a low volume of requests over a long period, or UNKNOWN to defer this optimization. Specify OTHER as a fallback value.

• catalogSize (enum string): Optimize based on the total size of the content library delivered, either SMALL (under 100GB), MEDIUM (100GB–1TB), LARGE (1TB–100TB), EXTRA_LARGE (more than 100TB), or UNKNOWN to defer this optimization. Specify OTHER as a fallback value.

• contentType (enum string): Optimize based on the type of content, either VIDEO, SOFTWARE, SOFTWARE_PATCH, GAME, GAME_PATCH, OTHER_DOWNLOADS, or UNKNOWN to defer this optimization.

• optimizeOption (boolean): When enabled, optimizes the delivery throughput and download times for large files.

• objectSize (enum string): Optimize based on the size of the object retrieved from the origin, either LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, or UNKNOWN to defer this optimization.

• popularityDistribution (enum string): Optimize based on the content’s expected popularity, either ALL_POPULAR for a high volume of requests over a short period, LONG_TAIL for a low volume of requests over a long period, or UNKNOWN to defer this optimization.

• catalogSize (enum string): Optimize based on the total size of the content library delivered, either SMALL (under 100GB), MEDIUM (100GB–1TB), LARGE (1TB–100TB), EXTRA_LARGE (more than 100TB), or UNKNOWN to defer this optimization.

• contentType (enum string): Optimize based on the type of content, either VIDEO, SOFTWARE, SOFTWARE_PATCH, GAME, GAME_PATCH, OTHER_DOWNLOADS, or UNKNOWN to defer this optimization.

• catalogSize (enum string): Optimize based on the total size of the content library delivered, either SMALL (under 100GB), MEDIUM (100GB–1TB), LARGE (1TB–100TB), EXTRA_LARGE (more than 100TB), or UNKNOWN to defer this optimization.

• contentType (enum string): Optimize based on the quality of media content, either SD (standard definition), HD (high definition), ULTRA_HD, OTHER for more than one level of quality, or UNKNOWN to defer this optimization.

• popularityDistribution (enum string): Optimize based on the content’s expected popularity, either ALL_POPULAR for a high volume of requests over a short period, LONG_TAIL for a low volume of requests over a long period, or UNKNOWN to defer this optimization.

• hls (boolean): Enable delivery of HLS media.

• segmentDurationHLS (enum string): With the hls option enabled, specifies the duration of individual segments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S.

• segmentSizeHLS (enum string): With the hls option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• hds (boolean): Enable delivery of HDS media.

• segmentDurationHDS (enum string): With the hds option enabled, specifies the duration of individual fragments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S.

• segmentSizeHDS (enum string): With the hds option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• dash (boolean): Enable delivery of DASH media.

• segmentDurationDASH (enum string): With the dash option enabled, specifies the duration of individual segments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S.

• segmentSizeDASH (enum string): With the dash option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• smooth (boolean): Enable delivery of Smooth media.

• segmentDurationSmooth (enum string): With the smooth option enabled, specifies the duration of individual fragments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S.

• segmentSizeSmooth (enum string): With the smooth option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• catalogSize (enum string): Optimize based on the total size of the content library delivered, either SMALL (under 100GB), MEDIUM (100GB–1TB), LARGE (1TB–100TB), EXTRA_LARGE (more than 100TB), or UNKNOWN to defer this optimization.

• contentType (enum string): Optimize based on the quality of media content, either SD (standard definition), HD (high definition), ULTRA_HD, OTHER for more than one level of quality, or UNKNOWN to defer this optimization.

• popularityDistribution (enum string): Optimize based on the content’s expected popularity, either ALL_POPULAR for a high volume of requests over a short period, LONG_TAIL for a low volume of requests over a long period, or UNKNOWN to defer this optimization.

• hls (boolean): Enable delivery of HLS media.

• segmentDurationHLS (enum string): With the hls option enabled, specifies the duration of individual segments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S.

• segmentSizeHLS (enum string): With the hls option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• hds (boolean): Enable delivery of HDS media.

• segmentDurationHDS (enum string): With the hds option enabled, specifies the duration of individual fragments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S.

• segmentSizeHDS (enum string): With the hds option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• dash (boolean): Enable delivery of DASH media.

• segmentDurationDASH (enum string): With the dash option enabled, specifies the duration of individual segments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S.

• segmentSizeDASH (enum string): With the dash option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• smooth (boolean): Enable delivery of Smooth media.

• segmentDurationSmooth (enum string): With the smooth option enabled, specifies the duration of individual fragments, either SEGMENT_DURATION_2S, SEGMENT_DURATION_4S, SEGMENT_DURATION_6S, SEGMENT_DURATION_8S, or SEGMENT_DURATION_10S.

• segmentSizeSmooth (enum string): With the smooth option enabled, specifies the size of the media object retrieved from the origin, either: LESS_THAN_1MB, ONE_MB_TO_TEN_MB, TEN_MB_TO_100_MB, GREATER_THAN_100MB, OTHER for sizes that straddle these ranges, or UNKNOWN to defer this optimization.

• enabled (boolean): Enables the Content Targeting feature.

• enableGeoProtection (boolean): When enabled, verifies IP addresses are unique to specific geographic regions.

• geoProtectionMode (enum string): With enableGeoProtection enabled, specifies whether to ALLOW or DENY requests.

• countries (array of string values): With enableGeoProtection enabled, specifies a set of two-character ISO 3166 country codes from which to allow or deny traffic. See EdgeScape Data Codes for a list.

• regions (array of string values): With enableGeoProtection enabled, specifies a set of ISO 3166–2 regional codes from which to allow or deny traffic. See EdgeScape Data Codes for a list.

• dmas (array of string values): With enableGeoProtection enabled, specifies the set of Designated Market Area codes from which to allow or deny traffic. See EdgeScape Data Codes for a list.

• overrideIPAddresses (array of string values): With enableGeoProtection enabled, specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.

• enableGeoRedirectOnDeny (boolean): When enabled, redirects denied requests rather than responding with an error code.

• geoRedirectUrl (string): With enableGeoRedirectOnDeny enabled, this specifies the full URL to the redirect page for denied requests.

• enableIPProtection (boolean): When enabled, allows you to control access to your content from specific sets of IP addresses and CIDR blocks.

• ipProtectionMode (enum string): With enableIPProtection enabled, specifies whether to ALLOW or DENY requests.

• ipAddresses (array of string values): With enableIPProtection enabled, specify a set of IP addresses or CIDR blocks to allow or deny.

• enableIPRedirectOnDeny (boolean): When enabled, redirects denied requests rather than responding with an error code.

• ipRedirectUrl (string): With enableIPRedirectOnDeny enabled, this specifies the full URL to the redirect page for denied requests.

• enableReferrerProtection (boolean): When enabled, allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.

• referrerProtectionMode (enum string): With enableReferrerProtection enabled, specify whether to ALLOW or DENY traffic from specified domains.

• referrerDomains (array of string values): With enableReferrerProtection enabled, specifies the set of domains from which to allow or deny traffic.

• enableReferrerRedirectOnDeny (boolean): When enabled, redirects denied requests rather than responding with an error code.

• referrerRedirectUrl (string): With enableReferrerRedirectOnDeny enabled, this specifies the full URL to the redirect page for denied requests.

• value (object): Specifies a value object, which includes an id key and a descriptive name:

  "value": {
      "id"   : 12345,
      "name" : "my cpcode"
  }
  

• behaviorId (string): The unique identifier for the predefined custom behavior you want to insert into the current rule.

• enabled (boolean): Enables DataStream reporting.

• datastreamIds (string): A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don’t apply to this property has no effect, and results in no data reported.

• enabled (boolean): Enables IoT Edge Connect.

• namespaceId (string): Specifies the globally reserved name for a specific configuration. It includes authorization rules over publishing and subscribing to logical categories known as topics. This provides a root path for all topics defined within a namespace configuration. You can use the IoT Edge Connect API to configure access control lists for your namespace configuration.

• tlsenabled (boolean): When enabled, you can publish and receive messages over a secured MQTT connection on port 8883.

• wsenabled (boolean): When enabled, you can publish and receive messages through a secured MQTT connection over WebSockets on port 443.

• gwenabled (boolean): When enabled, you can publish and receive messages over a secured HTTP connection on port 443.

• hashConversionAlgorithm (enum string): Choose either MD5, SHA256, or SHA384 hash algorithms.

• hashConversionKey (string): Specifies the key to generate the hash, ideally a long random string to ensure adequate security.

• regexPattern (string): Specifies a Perl-compatible regular expression with a single grouping to capture the text. For example, a value of ^.(.{0,10}) omits the first character, but then captures up to 10 characters after that. If the regular expression does not capture a substring, authentication may fail.

• substringStart (string): The zero-based index offset of the first character to extract. If the index is out of bound from the string’s length, authentication may fail.

• substringEnd (string): The zero-based index offset of the last character to extract, where -1 selects the remainder of the string. If the index is out of bound from the string’s length, authentication may fail.

• certificateField (enum string): Choose the field from the certificate to extract from, either FINGERPRINT_DYN, FINGERPRINT_MD5, FINGERPRINT_SHA1, SUBJECT_DN, SERIAL, V3_NETSCAPE_COMMENT, or V3_SUBJECT_ALT_NAME.

• dcpMutualAuthProcessingVariableId (enum string): Store the value either as VAR_DCP_CLIENT_ID or VAR_DCP_AUTH_GROUP.

• groupNames (array of string values): Specifies the set of authorization groups to assign to all connecting devices.

• enabled (boolean): Enables the default JWT server and sets the authentication endpoint to a default path.

• customValues (boolean): When enabled, allows you to specify custom JWT server connection values.

• hostname (string): With customValues enabled, specifies the JWT server’s hostname.

• path (string): With customValues enabled, specifies the path to your JWT server’s authentication endpoint. This lets you generate JWTs to sign your requests.

• enabled (read-only string): When on, enables the behavior.

• enabled (boolean): Denies access when enabled.

• reason (string): Text message that keys why access is denied. Any subsequent denyaccess behaviors within the rule tree may refer to the same reason key to override the current behavior.

• elements (array of string values): Specifies a set of information about the device with which to generate a separate cache key, any of the following values:

ACCEPT_THIRD_PARTY_COOKIE
AJAX_PREFERRED_GEOLOC_API
AJAX_SUPPORT_JAVASCRIPT
BRAND_NAME
COOKIE_SUPPORT
DEVICE_OS
DEVICE_OS_VERSION
DUAL_ORIENTATION
FLASH_LITE_VERSION
FULL_FLASH_SUPPORT
GIF_ANIMATED
HTML_PREFERRED_DTD
IS_MOBILE
IS_TABLET
IS_WIRELESS_DEVICE
JPG
MARKETING_NAME
MAX_IMAGE_HEIGHT
MAX_IMAGE_WIDTH
MOBILE_BROWSER
MOBILE_BROWSER_VERSION
MODEL_NAME
PDF_SUPPORT
PHYSICAL_SCREEN_HEIGHT
PHYSICAL_SCREEN_WIDTH
PNG
PREFERRED_MARKUP
RESOLUTION_HEIGHT
RESOLUTION_WIDTH
VIEWPORT_INITIAL_SCALE
VIEWPORT_WIDTH
XHTML_FILE_UPLOAD
XHTML_PREFERRED_CHARSET
XHTML_SUPPORT_LEVEL
XHTML_SUPPORTS_IFRAME
XHTML_SUPPORTS_TABLE_FOR_LAYOUT
XHTML_TABLE_SUPPORT
XHTMLMP_PREFERRED_MIME_TYPE

• elements (array of string values): Specifies the set of information about the requesting device to send to the origin server, any of the following:

ACCEPT_THIRD_PARTY_COOKIE
AJAX_PREFERRED_GEOLOC_API
AJAX_SUPPORT_JAVASCRIPT
BRAND_NAME
COOKIE_SUPPORT
DEVICE_OS
DEVICE_OS_VERSION
DUAL_ORIENTATION
FLASH_LITE_VERSION
FULL_FLASH_SUPPORT
GIF_ANIMATED
HTML_PREFERRED_DTD
IS_MOBILE
IS_TABLET
IS_WIRELESS_DEVICE
JPG
MARKETING_NAME
MAX_IMAGE_HEIGHT
MAX_IMAGE_WIDTH
MOBILE_BROWSER
MOBILE_BROWSER_VERSION
MODEL_NAME
PDF_SUPPORT
PHYSICAL_SCREEN_HEIGHT
PHYSICAL_SCREEN_WIDTH
PNG
PREFERRED_MARKUP
RESOLUTION_HEIGHT
RESOLUTION_WIDTH
VIEWPORT_INITIAL_SCALE
VIEWPORT_WIDTH
XHTML_FILE_UPLOAD
XHTML_PREFERRED_CHARSET
XHTML_SUPPORT_LEVEL
XHTML_SUPPORTS_IFRAME
XHTML_SUPPORTS_TABLE_FOR_LAYOUT
XHTML_TABLE_SUPPORT
XHTMLMP_PREFERRED_MIME_TYPE

• enabled (boolean): When enabled, allows edge servers to refresh an expired DNS record after serving content.

• timeout (duration string): Set the maximum allowed time an expired DNS record may be active.

• enabled (boolean): When enabled, allows edge servers to refresh DNS records before they expire.

• delay (duration string): Specifies the amount of time following a DNS record’s expiration to asynchronously prefresh it.

• timeout (duration string): Specifies the amount of time to prefresh a DNS entry if there have been no requests to the domain name.

• enabled (boolean): Enables the protocol downgrading behavior.

• behavior (enum string): Specify the caching instructions the edge server sends to the end user’s client. It accepts the following values:

  • ALLOW: The value of allowBehavior chooses the caching method and headers to send to the client.
  • MUST_REVALIDATE: This equates to a Cache-Control: no-cache header, which allows caching but forces the client browser to send an if-modified-since request each time it requests the object.
  • BUST: Sends cache-busting headers downstream.
  • TUNNEL_ORIGIN: This passes Cache-Control and Expires headers from the origin to the downstream client.
  • NONE: Don’t send any caching headers. Allow client browsers to cache content according to their own default settings.

• allowBehavior (enum string): Specify how the edge server calculates the downstream cache by setting the value of the Expires header:

  • FROM_VALUE sends the value of the edge cache’s duration.
  • FROM_MAX_AGE sends the cache:max-age value applied to the object, without evaluating the cache’s duration.
  • LESSER sends the lesser value of what the origin specifies and the edge cache’s remaining duration. This is the default behavior.
  • GREATER sends the greater value of what the origin specifies and the edge cache’s remaining duration.
  • REMAINING_LIFETIME sends the value of the edge cache’s remaining duration, without comparing it to the origin’s headers.
  • PASS_ORIGIN sends the value of the origin’s header, without evaluating the edge cache’s duration.

• ttl (duration string): Set the duration of the cache. Setting the value to 0 equates to a no-cache header that forces revalidation.

• sendHeaders (enum string): Specifies the HTTP headers to include in the response to the client:

  • PASS_ORIGIN sends the same set of Cache-Control and Expires headers received from the origin.
  • CACHE_CONTROL sends only the origin’s Cache-Control header.
  • EXPIRES sends only the origin’s Expires header.
  • CACHE_CONTROL_AND_EXPIRES sends both Cache-Control and Expires header.
  • NONE strips both headers.

• sendPrivate (boolean): When enabled, adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy.

• enabled (boolean): Enables the quick retry feature.

• sureRoute (boolean): Optimizes how subcustomer traffic routes from origin to edge servers. See the sureRoute behavior for more information.

• prefetch (boolean): Allows subcustomer content to prefetch over HTTP/2.

• realUserMonitoring (boolean): Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the realUserMonitoring behavior for more information.

• imageCompression (boolean): Enables image compression for subcustomer content.

• enabled (boolean): Enables Cloud Monitor’s log-publishing behavior.

• apiConnector (enum string): Describes the API connector type, either DEFAULT, BMC_APM, or SIEM_JSON.

• apiDataElements (array of string values): Specifies the data set to log, any of the following values:

APM
GEO
HTTP
NETWORK_PERFORMANCE
NETWORK_V1
REQUEST_HEADER
RESPONSE_HEADER
SEC_APP_V2
SEC_RATE_DENY_V2
SEC_RATE_WARN_V2

• destinationHostname (string): Specifies the target hostname accepting push API requests.

• destinationPath (string): Specifies the push API’s endpoint.

• overrideAggregateSettings (boolean): When enabled, overrides default log settings.

• aggregateTime (duration string): With overrideAggregateSettings enabled, specifies how often logs are generated.

• aggregateLines (string): With overrideAggregateSettings enabled, specifies the maximum number of lines to include in each log.

• aggregateSize (string): With overrideAggregateSettings enabled, specifies the log’s maximum size.

• enabled (boolean): Enables the edge image conversion behavior.

• failover (boolean): If the request results in a server error, enabling this forwards it to the origin.

• usePolicy (boolean): Enables a specified set of image conversion policies.

• policies (array): With usePolicy enabled, specifies commands that when present or not in the query string release an error code.

• policyResponses (numeric enum): Specifies the HTTP error code if any policies conditions match, either 400, 403, 404, or 409.

• description (string): A description of what the xml block does.

• xml (string): A block of Akamai XML metadata.

• originId (string): Corresponds to the id specified by the edgeLoadBalancingOrigin behavior associated with this data center.

• description (string): Provides a description for the ELB data center, for your own reference.

• hostname (string): Specifies the data center’s hostname.

• cookieName (string): If using session persistence, this specifies the value of the cookie named in the corresponding edgeLoadBalancingOrigin behavior’s cookie_name option.

• enableFailover (boolean): When enabled, allows you to specify failover rules.

• ip (string): With enableFailover enabled, specifies this data center’s IP address.

• failoverRules (array): With enableFailover enabled, provides up to four failover rules to apply in the specified order. These rules appear as objects with the following fields:

  • modify_request (boolean): When enabled, allows you to modify the request’s hostname or path.

  • override_hostname (boolean): When enabled, overrides the request’s hostname with the failover_hostname.

  • failover_hostname: The hostname of the data center to fail over to.

  • context_root: Specifies the path to use in the forwarding request, typically the root (/) when failing over to a different data center, or a full path such as /static/error.html when failing over to an error page.

  • absolute_path (boolean): If enabled, the path specified by context_root is interpreted as an absolute server path, for example to reference a site-down page. If disabled, the path is appended to the request.

• id (string): Specifies a unique descriptive string for this ELB origin. The value must match the origin_id specified by the edgeLoadBalancingDataCenter behavior associated with this origin.

• description (string): Provides a description for the ELB origin, for your own reference.

• hostname (string): Specifies the hostname associated with the ELB rule.

• enableSessionPersistence (boolean): When enabled, allows you to specify a cookie to pin the user’s browser session to one data center. When disabled, ELB’s default load balancing may send users to various data centers within the same session.

• cookieName (string): With enableSessionPersistence enabled, this specifies the name of the cookie that marks users’ persistent sessions. The accompanying edgeLoadBalancingDataCenter behavior’s description option specifies the cookie’s value.

• enabled (boolean): Enables the cookie-authorization behavior.

• cookieName (string): Specifies the name of the cookie to use for authorization.

• value (string): Specifies the value of the authorization cookie.

• domain (string): Specify the cookie’s domain, which must match the top-level domain of the Host header the origin server receives.

• enabled (boolean): Enables the Edge Redirector Cloudlet.

• cloudletPolicy (object): Specifies the Cloudlet policy as an object containing two members: a descriptive name string and an integer id set by the Cloudlet application.

• enabled (boolean): When enabled, sends the X-Akamai-Edgescape request header to the origin.

• enabled (boolean): Enables ESI processing.

• enableViaHttp (boolean): Enable ESI only for content featuring the following HTTP response header: Edge-control: dca=esi

• passSetCookie (boolean): When enabled, allows edge servers to pass your origin server’s cookies to the ESI processor.

• passClientIp (boolean): When enabled, allows edge servers to pass the client IP header to the ESI processor.

• i18nStatus (boolean): When enabled, provides internationalization support for ESI.

• i18nCharset (array of string values): With i18nStatus enabled, specifies the character sets to use when transcoding the ESI language, UTF-8 and ISO-8859-1 for example.

• detectInjection (boolean): When enabled, denies attempts to inject ESI code.

• enabled (boolean): Applies GeoGuard proxy detection.

• enableConfigurationMode (enum string): Sets either a default BEST_PRACTICE mode to apply a single action to the four different categories of traffic, or ADVANCED to configure them separately. Choose the latter only if you are thoroughly familiar in GeoGuard proxy detection.

• bestPracticeAction (enum string): With enableConfigurationMode set to BEST_PRACTICE, specifies whether to ALLOW, DENY, or REDIRECT the proxy request.

• bestPracticeRedirecturl (string): With bestPracticeAction set to REDIRECT, this specifies the URL to which to redirect requests.

• detectAnonymousVpn (boolean): With enableConfigurationMode set to ADVANCED, this enables detection of requests from anonymous VPNs.

• detectAnonymousVpnAction (enum string): With detectAnonymousVpn enabled, specifies whether to ALLOW, DENY, or REDIRECT anonymous VPN requests.

• detectAnonymousVpnRedirecturl (string): With detectAnonymousVpnAction set to REDIRECT, this specifies the URL to which to redirect anonymous VPN requests.

• detectPublicProxy (boolean): With enableConfigurationMode set to ADVANCED, this enables detection of requests from public proxies.

• detectPublicProxyAction (enum string): With detectPublicProxy enabled, specifies whether to ALLOW, DENY, or REDIRECT public proxy requests.

• detectPublicProxyRedirecturl (string): With detectPublicProxyAction set to REDIRECT, this specifies the URL to which to redirect public proxy requests.

• detectTorExitNode (boolean): With enableConfigurationMode set to ADVANCED, this enables detection of requests from Tor exit nodes.

• detectTorExitNodeAction (enum string): With detectTorExitNode enabled, specifies whether to DENY, ALLOW, or REDIRECT requests from Tor exit nodes.

• detectTorExitNodeRedirecturl (string): With detectTorExitNodeAction set to REDIRECT, this specifies the URL to which to redirect requests from Tor exit nodes.

• detectSmartDNSProxy (boolean): With enableConfigurationMode set to ADVANCED, this enables detection of requests from smart DNS proxies.

• detectSmartDNSProxyAction (enum string): With detectSmartDNSProxy enabled, specifies whether to DENY, ALLOW, or REDIRECT smart DNS proxy requests.

• detectSmartDNSProxyRedirecturl (string): With detectSmartDNSProxyAction set to REDIRECT, this specifies the URL to which to redirect DNS proxy requests.

• detectVpnDataCenter (boolean): With enableConfigurationMode set to ADVANCED, this enables detection of requests from VPN data centers. You should learn more about this GeoGuard category before enabling it.

• detectVpnDataCenterAction (enum string): With detectVpnDataCenter enabled, specifies whether to DENY, ALLOW, or REDIRECT requests from VPN data centers.

• detectVpnDataCenterRedirecturl (string): With detectVpnDataCenterAction set to REDIRECT, this specifies the URL to which to redirect requests from VPN data centers. …

• enabled (boolean): When enabled in case of a failure to contact the origin, the current behavior applies.

• actionType (enum string): Specifies the basic action to take when there is a failure to contact the origin:

  • SERVE_STALE serves content that is already in the cache.
  • REDIRECT specifies a redirect action. (Use with these options: redirectHostnameType, redirectHostname, redirectCustomPath, redirectPath, redirectMethod, modifyProtocol, and protocol.)
  • RECREATED_CEX serves alternate content from an external network. (Use with these options: cexHostname, cexCustomPath, and cexPath.)
  • RECREATED_CO serves alternate content from your network. (Use with these options: contentHostname, contentCustomPath, and contentPath.)
  • RECREATED_NS serves NetStorage content. (Use with these options: netStorageHostname, netStoragePath, and cpCode.)
  • DYNAMIC allows you to serve dynamic SaaS content if SaaS acceleration is available on your contract. (Use with these options: dynamicMethod, dynamicCustomPath, saasType, saasSuffix, saasRegex, and saasReplace.)

• statusCode (numeric enum): Assigns a new HTTP status code to the failure response.

• cpCode (object): When actionType is RECREATED_NS, this specifies a cpcode for which to log errors for the NetStorage location. It appears as an object that includes an id key and a descriptive name:

  "cpCode": {
      "id"   : 12345,
      "name" : "my cpcode"
  }
  

• netStorageHostname (object): When the actionType is RECREATED_NS, specifies the NetStorage origin to serve the alternate content, as in the example below. Contact Akamai Professional Services for your NetStorage origin’s id.

  "netStorageHostname": {
      "id"                 : "netstorage_id",
      "name"               : "Example Downloads",
      "downloadDomainName" : "download.example.com",
      "cpCode"             : 12345
  }
  

• netStoragePath (string; allows variables): When the actionType is RECREATED_NS, specifies the path for the NetStorage request.

• redirectMethod (numeric enum): When the actionType is REDIRECT, specifies the HTTP response code, either 301 or 302.

• redirectHostnameType (enum string): When the actionType is REDIRECT, this specifies whether to preserve the ORIGINAL hostname in the redirect, or whether to use an ALTERNATE hostname specified with redirectHostname.

• redirectHostname (string; allows variables): When the actionType is REDIRECT and the redirectHostnameType is ALTERNATE, this specifies the hostname for the redirect.

• redirectCustomPath (boolean): When the actionType is REDIRECT, enabling this allows you use redirectPath to customize a new path.

• redirectPath (string; allows variables): When the actionType is REDIRECT, this specifies a new path.

• modifyProtocol (boolean): When the actionType is REDIRECT, or if the dynamicMethod is either SERVE_301 or SERVE_302, enabling this allows you to modify the redirect’s protocol using the value of the protocol field.

• protocol (enum string): When the actionType is REDIRECT and modifyProtocol is enabled, this specifies the redirect’s protocol, either HTTP or HTTPS.

• preserveQueryString (boolean): When using either contentCustomPath, cexCustomPath, dynamicCustomPath, or redirectCustomPath to specify a custom path, enabling this passes in the original request’s query string as part of the path.

• cexHostname (string; allows variables): When actionType is RECREATED_CEX, this specifies a hostname.

• cexCustomPath (boolean): When actionType is RECREATED_CEX, enabling this allows you to specify a custom path.

• cexPath (string; allows variables): When actionType is RECREATED_CEX and cexCustomPath is enabled, this specifies a custom path.

• contentHostname (string; allows variables): When the actionType is RECREATED_CO, specifies the static hostname for the alternate redirect.

• contentCustomPath (boolean): When the actionType is RECREATED_CO, enabling this allows you to specify a custom redirect path.

• contentPath (string; allows variables): When the actionType is RECREATED_CO and contentCustomPath is enabled, this specifies a custom redirect path.

• dynamicMethod (enum string): With the actionType set to DYNAMIC, specifies the redirect method, either SERVE_301, SERVE_302, or SERVE_ALTERNATE.

• dynamicCustomPath (boolean): When enabled, allows you to modify the original requested path.

• dynamicPath (string; allows variables): With dynamicCustomPath enabled, specifies the new path.

• saasType (enum string): Identifies the component of the request that identifies the SaaS dynamic failaction: either COOKIE, HOSTNAME, PATH, or QUERY_STRING.

• saasSuffix (string; allows variables): With actionType set to DYNAMIC, specifies the static portion of the SaaS dynamic failaction.

• saasRegex (string): With actionType set to DYNAMIC, specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.

• saasReplace (string; allows variables): With actionType set to DYNAMIC, specifies the replacement pattern that defines the SaaS dynamic failaction.

• saasCnameEnabled (boolean): With the saasType set to HOSTNAME, specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.

• saasCnameLevel (number): With saasCnameEnabled on, specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.

• saasCookie (string; allows variables): With saasType set to COOKIE, specifies the name of the cookie that identifies this SaaS dynamic failaction.

• saasQueryString (string; allows variables): With saasType set to QUERY_STRING, specifies the name of the query parameter that identifies this SaaS dynamic failaction.

• enabled (boolean): When enabled, forces a validation test for all edge content to which the behavior applies.

• enabled (boolean): Enables the Cloud Marketing Cloudlet.

• javaScriptInsertionRule (enum string): Select how to insert the MediaMath JavaScript reference script, either NEVER if inserting it at the origin, ALWAYS to insert it for all edge requests, or POLICY to allow the Cloudlet policy to determine when to insert it.

• cloudletPolicy (object): Identifies the Cloudlet policy in an object featuring unique numeric id and descriptive string name members.

• mediaMathPrefix (string): Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.

• enabled (boolean): Enables the Cloud Marketing Plus Cloudlet.

• javaScriptInsertionRule (enum string): Select how to insert the MediaMath JavaScript reference script, either NEVER if inserting it at the origin, ALWAYS to insert it for all edge requests, or POLICY to allow the Cloudlet policy to determine when to insert it.

• cloudletPolicy (object): Identifies the Cloudlet policy in an object featuring unique numeric id and descriptive string name members.

• mediaMathPrefix (string): Specify the URL path prefix that distinguishes Cloud Marketing requests from your other web traffic. Include the leading slash character, but no trailing slash. For example, if the path prefix is /mmath, and the request is for www.example.com/dir, the new URL is www.example.com/mmath/dir.

• enabled (boolean): Enables the Forward Rewrite Cloudlet behavior.

• cloudletPolicy (object): Identifies the Cloudlet policy in an object featuring unique numeric id and descriptive string name members.

• enabled (boolean): Enables the front-end optimization behavior.

• enabled (boolean): Enables the g2o verification behavior.

• dataHeader (string): Specifies the name of the header that contains the request data that needs to be encrypted.

• signedHeader (string): Specifies the name of the header containing encrypted request data.

• encodingVersion (numeric enum): Specifies the version of the encryption algorithm as an integer from 1 through 5.

• useCustomSignString (boolean): When disabled, the encrypted string is based on the forwarded URL. If enabled, you can use customSignString to customize the set of data to encrypt.

• customSignString (array of string values): With useCustomSignString enabled, specifies the set of data to be encrypted as a combination of concatenated strings, any of the following values:

AK_CLIENT_REAL_IP
AK_DOMAIN
AK_EXTENSION
AK_FILENAME
AK_HOSTHEADER
AK_METHOD
AK_PATH
AK_QUERY
AK_SCHEME
AK_URL

• secretKey (string): Specifies the shared secret key.

• nonce (string): Specifies the cryptographic nonce string.

• outputOption (enum string): Specifies how to report the GRN value, either as a RESPONSE_HEADER to the client, a REQUEST_HEADER to the origin, BOTH_HEADERS, or ASSIGN_VARIABLE to process the value in some other way as a variable.

• headerName (string): With outputOption set to specify any set of headers, this specifies the name of the header to report the GRN value.

• variableName (string): With outputOption set to ASSIGN_VARIABLE, this specifies the name of the variable to assign the GRN value to. You need to pre-declare any variable you specify within the rule tree.

• behavior (enum string): Specify when to compress responses, either ALWAYS, NEVER, or ORIGIN_RESPONSE to clients that send an Accept-Encoding: gzip header.

• description (string): Human-readable description of what the XML block does.

• xml (string): A block of Akamai XML metadata.

• retryCount (number): The number of consecutive connection failures that mark an IP address as faulty.

• retryInterval (duration string): Specifies the amount of time the edge server will wait before trying to reconnect to an IP address it has already identified as faulty.

• maximumReconnects (number): Specifies the maximum number of times the edge server will contact your origin server. If your origin is associated with several IP addresses, maximumReconnects effectively overrides the value of retryCount.

• enable (boolean): Applies HSTS to this set of requests.

• maxAge (enum string): Specifies the duration for which to apply HSTS for new browser connections, either TEN_MINS, ONE_DAY, ONE_MONTH, THREE_MONTHS, SIX_MONTHS, or ONE_YEAR. A value of ZERO_MINS effectively disables HSTS, without affecting any existing browser connections.

• includeSubDomains (boolean): When enabled, applies HSTS to all subdomains.

• preload (boolean): When enabled, adds this domain to the browser’s preload list. You still need to declare the domain at hstspreload.org.

• redirect (boolean): When enabled, redirects all HTTP requests to HTTPS.

• redirectStatusCode (numeric enum): With redirect enabled, specifies a 301 or 302 response code.

• enabled (boolean): Enable image management capabilities and generate a corresponding API token.

• resize (boolean): Specify whether to scale down images to the maximum screen resolution, as determined by the rendering device’s user agent. Note that enabling this may affect screen layout in unexpected ways.

• applyBestFileType (boolean): Specify whether to convert images to the best file type for the requesting device, based on its user agent and the initial image file. This produces the smallest file size possible that retains image quality.

• superCacheRegion (enum string): Specifies a location for your site’s heaviest traffic, for use in caching derivatives on edge servers. Possible values are US, JAPAN, ASIA, AUSTRALIA, or EMEA (Europe, Middle East, and Africa).

• cpCodeOriginal (object): Assigns a CP code to track traffic and billing for original images that the Image and Video Manager has not modified. Form the value as an object with a single id member paired with an integer value, for example: "cpCodeOriginal":{"id":12345}.

• cpCodeTransformed (object): Assigns a separate CP code to track traffic and billing for derived images. Form the value as an object with a single id member paired with an integer value, for example: "cpCodeTransformed":{"id":12345}.

• advanced (boolean): When enabled, allows you to generate a custom Image and Video Manager API token to apply a corresponding policy to this set of images. The token consists of a descriptive label (the policyToken) concatenated with a property-specific identifier that’s generated when you save the property. The API registers the token when you activate the property.

• policyToken (string): With advanced enabled, assign a prefix label to help match the policy token to this set of images, limited to 32 alphanumeric or underscore characters. If you don’t specify a label, default becomes the prefix.

• policyTokenDefault (string): Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property. The advanced option needs to be inactive.

• enabled (boolean): Applies Image and Video Manager’s video optimization to the current content.

• resize (boolean): When enabled, scales down video for smaller mobile screens, based on the device’s User-Agent header.

• applyBestFileType (boolean): When enabled, automatically converts videos to the best file type for the requesting device. This produces the smallest file size that retains image quality, based on the user agent and the initial image file.

• superCacheRegion (enum string): To optimize caching, assign a region close to your site’s heaviest traffic, either ASIA, AUSTRALIA, EMEA (Europe, Middle East and Africa), JAPAN, or US. Assign US if your site’s heaviest traffic varies across regions.

• cpCodeOriginal (object): Select the CP code for which to track Image and Video Manager video traffic. Use this along with cpCodeTransformed to track traffic to derivative video content.

• cpCodeTransformed (object): Select the CP code to identify derivative transformed video content.

• advanced (boolean): When disabled, applies a single standard policy based on your property name. When enabled, allows you to reference a rule-specific policyToken for videos with different match criteria.

• policyToken (string): With advanced enabled, specifies a custom policy defined in the Image and Video Manager Policy Manager or the Image and Video Manager API. The policy name can include up to 64 alphanumeric, dash, or underscore characters.

• policyTokenDefault (string): Specify the default policy identifier, which is registered with the Image and Video Manager API once you activate this property.

• override (enum string): Selects the type of query parameter you want to set, either the DPR for pixel density, FORMAT for browser types, POLICY for the name of the Image and Video Manager policy you want to apply, or the predefined WIDTH to constrain the image to. Alternately specify that you want to set an Image and Video Manager POLICY_VARIABLE from a rule tree variable defined in the property.

• typesel (enum string): When setting any query parameter, specifies whether to set it to a specific VALUE, or whether to assign a Property Manager rule tree VARIABLE.

• formatvar (string): With the override parameter set to FORMAT and the typesel set to VARIABLE, this selects the variable with the name of the browser you want to optimize images for. The variable specifies the same type of data as the format option below.

• format (enum string): With the override parameter set to FORMAT and the typesel set to VALUE, this specifies the name of the browser you want to optimize images for, either CHROME, SAFARI, IE, or GENERIC.

• dprvar (string): With the override parameter set to DPR and the typesel set to VARIABLE, this selects the variable with the desired pixel density. The variable specifies the same type of data as the dpr option below.

• dpr (number): With the override parameter set to DPR and the typesel set to VALUE, this directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.

• widthvar (string): With the override parameter set to WIDTH and the typesel set to VARIABLE, this selects the variable with the desired width. If the Image and Video Manager policy doesn’t define that width, it serves the next largest width.

• width (number): With the override parameter set to WIDTH and the typesel set to VALUE, this sets the image’s desired pixel width directly. If the Image Manager policy doesn’t define that width, it serves the next largest width.

• policyvar (string): With the override parameter set to POLICY and the typesel set to VARIABLE, this selects the variable with the desired Image and Video Manager policy name to apply to image requests. If there is no policy by that name, Image and Video Manager serves the image unmodified.

• policy (string): With the override parameter set to POLICY and the typesel set to VALUE, this selects the desired Image and Video Manager policy name directly. If there is no policy by that name, Image and Video Manager serves the image unmodified.

• policyvarName (string): With override set to POLICY_VARIABLE, this selects the name of one of the variables defined in an Image and Video Manager policy that you want to replace with the property’s rule tree variable.

• policyvarIMvar (string): With override set to POLICY_VARIABLE, this selects one of the property’s rule tree variables to assign to the policyvarName variable within Image and Video Manager.

• referenceId (boolean): Enables injection of reference ID values.

• enabled (boolean): Applies the Input Validation Cloudlet behavior.

• cloudletPolicy (object): Identifies the Cloudlet policy in an object featuring unique numeric id and descriptive string name members.

• label (string): Distinguishes this Input Validation policy from any others within the same property.

• userIdentificationByCookie (boolean): When enabled, identifies users by the value of a cookie.

• userIdentificationKeyCookie (string): With userIdentificationByCookie enabled, this specifies the cookie name whose value must remain constant across requests to identify a user.

• userIdentificationByIp (boolean): When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.

• userIdentificationByHeaders (boolean): When enabled, identifies users by specific HTTP headers on GET or POST requests.

• userIdentificationKeyHeaders (array of string values): With userIdentificationByHeaders enabled, this specifies the HTTP headers whose combined set of values identify each end user.

• userIdentificationByParams (boolean): When enabled, identifies users by specific query parameters on GET or POST requests.

• userIdentificationKeyParams (array of string values): With userIdentificationByParams enabled, this specifies the query parameters whose combined set of values identify each end user.

• allowLargePostBody (boolean): Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.

• resetOnValid (boolean): Upon receiving a valid request, enabling this resets the penaltyThreshold counter to zero. Otherwise, even those series of invalid requests that are interrupted by valid requests may trigger the penaltyAction.

• validateOnOriginWith (enum string): For any validation that edge servers can’t perform alone, this specifies additional validation steps based on how the origin identifies an invalid request. If a request is invalid, the origin can indicate this to the edge server either with a RESPONSE_CODE or RESPONSE_CODE_AND_HEADER. If no additional validation is necessary, specify DISABLED.

• validateOnOriginHeaderName (string): If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies the header name for a request that the origin identifies as invalid.

• validateOnOriginHeaderValue (string): If validateOnOriginWith is set to RESPONSE_CODE_AND_HEADER, this specifies an invalid request’s header value that corresponds to the validateOnOriginHeaderName.

• validateOnOriginResponseCode (number): Unless validateOnOriginWith is DISABLED, this identifies the integer response code for requests the origin identifies as invalid.

• failure302Uri (string): Specifies the redirect link for invalid requests that have not yet triggered a penalty.

• penaltyThreshold (number): Specifies the number of invalid requests permitted before executing the penaltyAction.

• penaltyAction (enum string): Once the penaltyThreshold of invalid requests is met, this specifies the response, either BRANDED_403, BLANK_403 or REDIRECT_302.

• penalty302Uri (string): With penaltyAction set to REDIRECT_302, this specifies the redirect link for end users who trigger the penalty.

• penaltyNetStorage (object): With penaltyAction set to BRANDED_403, this specifies the NetStorage account that serves out the penalty’s static 403 response content. Details appear in an object featuring a downloadDomainName string member that identifies the NetStorage hostname, and an integer cpCode to track the traffic.

• penalty403NetStoragePath (string): With penaltyAction set to BRANDED_403, this specifies the full path to the static 403 response content relative to the downloadDomainName in the penaltyNetStorage object.

• penaltyBrandedDenyCacheTtl (number within 5–30 range): With penaltyAction set to BRANDED_403, this specifies the penalty response’s time to live in the cache, 5 minutes by default.

• prefetchCacheable (boolean): When enabled, applies prefetching only to objects already set to be cacheable, for example using the caching behavior. Only applies to content with the tieredDistribution behavior enabled.

• prefetchNoStore (boolean): Allows otherwise non-cacheable no-store content to prefetch if the URL path ends with / to indicate a request for a default file, or if the extension matches the value of the prefetchNoStoreExtensions option. Only applies to content with the sureRoute behavior enabled.

• prefetchNoStoreExtensions (array of string values): Specifies a set of file extensions for which the prefetchNoStore option is allowed.

• prefetchHtml (boolean): When enabled, allows edge servers to prefetch additional HTML pages while pages that link to them are being delivered. This only applies to links from <a> or <link> tags with the appropriate link relation attribute.

• customLinkRelations (array of string values): Specify link relation values that activate the prefetching behavior. For example, specifying fetch allows you to use shorter rel="fetch" markup.

• enabled (boolean): Enables the InstantConfig behavior.

• enabled (boolean): Enables the file optimization behavior.

• enablePartialObjectCaching (enum string): Caches entire objects if set to NON_PARTIAL_OBJECT_CACHING. Otherwise when set to PARTIAL_OBJECT_CACHING, allows partial-object caching, which always applies to large objects served from NetStorage. To enable this, the origin must support byte range requests.

• minimumSize (string): Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.

• maximumSize (string): Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as MB or GB.

• useVersioning (boolean): When enablePartialObjectCaching is set to PARTIAL_OBJECT_CACHING, enabling this option signals your intention to vary filenames by version, strongly recommended to avoid serving corrupt content when chunks come from different versions of the same file.

• enabled (boolean): Enables the file optimization behavior.

• objectSize (string): Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a MB or GB suffix.

• fragmentSize (enum string): Specifies the size of each fragment used for partial object caching, either HALF_MB, ONE_MB, TWO_MB, or FOUR_MB.

• prefetchDuringRequest (number): The number of POC fragments to prefetch during the request.

• prefetchAfterRequest (number): The number of POC fragments to prefetch after the request.

• enabled (boolean): When enabled, activates the bit rate limiting behavior.

• bitrateTable (array): Specifies a download rate that corresponds to a thresholdTable entry. The bit rate appears as a two-member object consisting of a numeric bitrateValue and a bitrateUnit string, with allowed values of Kbps, Mbps, and Gbps. For example:

  "bitrateTable": [
      {
          "bitrateValue": 1,
          "bitrateUnit": "Kbps"
      }
  ]
  

• thresholdTable (array): Specifies the minimum size of the file or the amount of elapsed download time before applying the bit rate limit from the corresponding bitrateTable entry. The threshold appears as a two-member object consisting of a numeric thresholdValue and thresholdUnit string, with allowed values of s or B. This example throttles a download that lasts more than 5 seconds:

  "thresholdTable": [
      {
          "thresholdValue": 5,
          "thresholdUnit": "s"
      }
  ]
  

• enabled (boolean): Enables the Manifest Personalization feature.

• hlsEnabled (boolean): When enabled, allows you to customize the HLS master manifest that’s sent to the requesting client.

• hlsMode (enum string): With hlsEnabled on, specify either the default BEST_PRACTICE mode, or a CUSTOM manifest.

• hlsPreferredBitrate (string): With hlsMode set to CUSTOM, sets the preferred bit rate in Kbps. This causes the media playlist specified in the #EXT-X-STREAM-INF tag that most closely matches the value to list first. All other playlists maintain their current position in the manifest.

• hlsFilterInBitrates (string): With hlsMode set to CUSTOM, specifies a comma-delimited set of preferred bit rates, such as 100,200,400. Playlists specified in the #EXT-X-STREAM-INF tag with bit rates outside of any of those values by up to 100 Kbps are excluded from the manifest.

• hlsFilterInBitrateRanges (string): With hlsMode set to CUSTOM, specifies a comma-delimited set of bit rate ranges, such as 100-400,1000-4000. Playlists specified in the #EXT-X-STREAM-INF tag with bit rates outside of any of those ranges are excluded from the manifest.

• hlsQueryParamEnabled (boolean): With hlsEnabled on, allows you to specify query parameters for the HLS master manifest to customize the manifest’s content. Any settings specified in the query string override those already configured in Property Manager.

• hlsQueryParamSecretKey (string): With hlsQueryParamEnabled on, specifies a primary key as a token to accompany the request.

• hlsQueryParamTransitionKey (string): With hlsQueryParamEnabled on, specifies a transition key as a token to accompany the request.

• hlsShowAdvanced (boolean): With hlsEnabled on, allows you to configure advanced settings.

• hlsEnableDebugHeaders (boolean): With hlsShowAdvanced enabled, includes additional Akamai-Manifest-Personalization and Akamai-Manifest-Personalization-Config-Source debugging headers.

• serverpushlist (array of string values): Specifies the set of objects to load into the client browser’s cache over HTTP2. Each value in the array represents a hostname and full path to the object, such as www.example.com/js/site.js

• enabled (boolean): Enables Media Acceleration.

• enabled (boolean): Enables client-side download analytics.

• beaconId (string): Specifies the ID of data source’s beacon.

• useHybridHttpUdp (boolean): Enables the hybrid HTTP/UDP protocol.

• enabled (boolean): Enables the partial-object caching behavior.

• detectOriginUnresponsive (boolean): When enabled, allows you to configure what happens when the origin is unresponsive.

• originUnresponsiveDetectionLevel (enum string): With detectOriginUnresponsive enabled, specify whether your response to slow origin connections should be AGGRESSIVE, MODERATE, or CONSERVATIVE.

• originUnresponsiveBlacklistOriginIp (boolean): With detectOriginUnresponsive enabled, enabling this blacklists the origin’s IP address.

• originUnresponsiveBlacklistWindow (enum string): With originUnresponsiveBlacklistOriginIp enabled, this sets the delay before blacklisting an IP address, either ONE_S, TEN_S, or THIRTY_S.

• originUnresponsiveRecovery (enum string): With detectOriginUnresponsive enabled, this sets the recovery option, either RETRY_X_TIMES, SWITCH_TO_BACKUP_ORIGIN, or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION.

• originUnresponsiveRetryLimit (enum string): With originUnresponsiveRecovery set to RETRY_X_TIMES, sets whether to retry ONE, TWO, or THREE times.

• originUnresponsiveBackupHost (string): With originUnresponsiveRecovery set to SWITCH_TO_BACKUP_ORIGIN, this specifies the origin hostname.

• originUnresponsiveAlternateHost (string): With originUnresponsiveRecovery set to REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, this specifies the redirect’s destination hostname.

• originUnresponsiveModifyRequestPath (boolean): With originUnresponsiveRecovery set to SWITCH_TO_BACKUP_ORIGIN or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, enabling this allows you to modify the request path.

• originUnresponsiveModifiedPath (string): With originUnresponsiveModifyRequestPath enabled, this specifies the path to form the new URL.

• originUnresponsiveIncludeQueryString (boolean): With originUnresponsiveModifyRequestPath enabled, enabling this includes the original set of query parameters.

• originUnresponsiveRedirectMethod (numeric enum): With originUnresponsiveRecovery set to REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, specifies either a 301 or 302 redirect response code.

• originUnresponsiveChangeProtocol (boolean): With originUnresponsiveRecovery set to SWITCH_TO_BACKUP_ORIGIN, or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, enabling this allows you to change the request protocol.

• originUnresponsiveProtocol (enum string): With originUnresponsiveChangeProtocol enabled, specifies either the HTTP or HTTPS protocol.

• detectOriginUnavailable (boolean): When enabled, allows you to configure failover settings when the origin server responds with errors.

• originUnavailableDetectionLevel (enum string): With detectOriginUnavailable enabled, specify RESPONSE_CODES, the only available option.

• originUnavailableResponseCodes (array of string values): With detectOriginUnavailable enabled, specifies the set of response codes identifying when the origin responds with errors.

• originUnavailableBlacklistOriginIp (boolean): With detectOriginUnavailable enabled, enabling this blacklists the origin’s IP address.

• originUnavailableBlacklistWindow (enum string): With originUnavailableBlacklistOriginIp enabled, this sets the delay before blacklisting an IP address, either ONE_S, TEN_S, or THIRTY_S.

• originUnavailableRecovery (enum string): With detectOriginUnavailable enabled, this sets the recovery option, either RETRY_X_TIMES, SWITCH_TO_BACKUP_ORIGIN, or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION.

• originUnavailableRetryLimit (enum string): With originUnavailableRecovery set to RETRY_X_TIMES, sets whether to retry ONE, TWO, or THREE times.

• originUnavailableBackupHost (string): With originUnavailableRecovery set to SWITCH_TO_BACKUP_ORIGIN, this specifies the origin hostname.

• originUnavailableAlternateHost (string): With originUnavailableRecovery set to REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, this specifies the redirect’s destination hostname.

• originUnavailableModifyRequestPath (boolean): With originUnavailableRecovery set to SWITCH_TO_BACKUP_ORIGIN or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, enabling this allows you to modify the request path.

• originUnavailableModifiedPath (string): With originUnavailableModifyRequestPath enabled, this specifies the path to form the new URL.

• originUnavailableIncludeQueryString (boolean): With originUnavailableModifyRequestPath enabled, enabling this includes the original set of query parameters.

• originUnavailableRedirectMethod (numeric enum): With originUnavailableRecovery set to REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, specifies either a 301 or 302 redirect response code.

• originUnavailableChangeProtocol (boolean): With originUnavailableRecovery set to SWITCH_TO_BACKUP_ORIGIN or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, enabling this allows you to modify the request protocol.

• originUnavailableProtocol (enum string): With originUnavailableChangeProtocol enabled, specifies either the HTTP or HTTPS protocol.

• detectObjectUnavailable (boolean): When enabled, allows you to configure failover settings when the origin has content errors.

• objectUnavailableDetectionLevel (enum string): With detectObjectUnavailable enabled, specify RESPONSE_CODES, the only available option.

• objectUnavailableResponseCodes (array of string values): With detectObjectUnavailable enabled, specifies the set of response codes identifying when there are content errors.

• objectUnavailableBlacklistOriginIp (boolean): With detectObjectUnavailable enabled, enabling this blacklists the origin’s IP address.

• objectUnavailableBlacklistWindow (enum string): With objectUnavailableBlacklistOriginIp enabled, this sets the delay before blacklisting an IP address, either ONE_S, TEN_S, or THIRTY_S.

• objectUnavailableRecovery (enum string): With detectObjectUnavailable enabled, this sets the recovery option, either RETRY_X_TIMES, SWITCH_TO_BACKUP_ORIGIN, or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION.

• objectUnavailableRetryLimit (enum string): With objectUnavailableRecovery set to RETRY_X_TIMES, sets whether to retry ONE, TWO, or THREE times.

• objectUnavailableBackupHost (string): With objectUnavailableRecovery set to SWITCH_TO_BACKUP_ORIGIN, this specifies the origin hostname.

• objectUnavailableAlternateHost (string): With objectUnavailableRecovery set to REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, this specifies the redirect’s destination hostname.

• objectUnavailableModifyRequestPath (boolean): With objectUnavailableRecovery set to SWITCH_TO_BACKUP_ORIGIN or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, enabling this allows you to modify the request path.

• objectUnavailableModifiedPath (string): With objectUnavailableModifyRequestPath enabled, this specifies the path to form the new URL.

• objectUnavailableIncludeQueryString (boolean): With objectUnavailableModifyRequestPath enabled, enabling this includes the original set of query parameters.

• objectUnavailableRedirectMethod (numeric enum): With objectUnavailableRecovery set to REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, specifies either a 301 or 302 redirect response code.

• objectUnavailableChangeProtocol (boolean): With objectUnavailableRecovery set to SWITCH_TO_BACKUP_ORIGIN or REDIRECT_TO_DIFFERENT_ORIGIN_LOCATION, enabling this allows you to change the request protocol.

• objectUnavailableProtocol (enum string): With objectUnavailableChangeProtocol enabled, specifies either the HTTP or HTTPS protocol.

• clientResponseCode (string): Specifies the response code served to the client.

• cacheErrorResponse (boolean): When enabled, caches the error response.

• cacheWindow (enum string): With cacheErrorResponse enabled, this sets error response’s TTL, either ONE_S, TEN_S, or THIRTY_S.

• enabled (boolean): Enables the Mobile App Performance SDK.

• secondaryMultipathToOrigin (boolean): When enabled, sends secondary multi-path requests to the origin server.

• action (enum string): Either ADD, DELETE, MODIFY, or PASS incoming HTTP request headers.

• standardAddHeaderName (enum string): If the value of action is ADD, this specifies the name of the field to add, either ACCEPT_ENCODING, ACCEPT_LANGUAGE, or OTHER.

• standardDeleteHeaderName (enum string): If the value of action is DELETE, this specifies the name of the field to remove, either IF_MODIFIED_SINCE, VIA, or OTHER.

• standardModifyHeaderName (enum string): If the value of action is MODIFY, this specifies the name of the field to modify, either ACCEPT_ENCODING, ACCEPT_LANGUAGE, or OTHER.

• standardPassHeaderName (enum string): If the value of action is PASS, this specifies the name of the field to pass through, either ACCEPT_ENCODING, ACCEPT_LANGUAGE, or OTHER.

• customHeaderName (string; allows variables): Specifies a custom field name that applies when the relevant standard header name is set to OTHER.

• headerValue (string; allows variables): With the action set to ADD, specifies the new header value.

• newHeaderValue (string; allows variables): With the action set to MODIFY, supplies an HTTP header replacement value.

• avoidDuplicateHeaders (boolean): When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.

• action (enum string): Either ADD, DELETE, MODIFY, or PASS incoming HTTP response headers.

• standardAddHeaderName (enum string): If the value of action is ADD, this specifies the name of the field to add, any of the following values:

CACHE_CONTROL
CONTENT_TYPE
EDGE_CONTROL
EXPIRES
LAST_MODIFIED
OTHER

• standardDeleteHeaderName (enum string): If the value of action is DELETE, this specifies the name of the field to remove, either CACHE_CONTROL, CONTENT_TYPE, VARY, or OTHER.

• standardModifyHeaderName (enum string): If the value of action is MODIFY, this specifies the name of the field to modify, either CACHE_CONTROL, CONTENT_TYPE, EDGE_CONTROL, or OTHER.

• standardPassHeaderName (enum string): If the value of action is PASS, this specifies the name of the field to pass through, either CACHE_CONTROL, EXPIRES, PRAGMA, or OTHER.

• customHeaderName (string; allows variables): Specifies a custom field name that applies when the relevant standard header name is set to OTHER.

• headerValue (string; allows variables): With the action set to ADD, specifies the header’s new value.

• newHeaderValue (string; allows variables): With the action set to MODIFY, specifies an HTTP header replacement value.

• avoidDuplicateHeaders (boolean): When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.

• action (enum string): Either ADD or DELETE outgoing HTTP request headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.

• standardAddHeaderName (enum string): If the value of action is ADD, this specifies the name of the field to add, either USER_AGENT or OTHER.

• standardDeleteHeaderName (enum string): If the value of action is DELETE, this specifies the name of the field to remove, either PRAGMA, USER_AGENT, VIA, or OTHER.

• standardModifyHeaderName (enum string): If the value of action is MODIFY or REGEX, this specifies the name of the field to modify, either USER_AGENT or OTHER.

• customHeaderName (string; allows variables): Specifies a custom field name that applies when the relevant standard header name is set to OTHER.

• headerValue (string; allows variables): With the action set to ADD, specifies the new header value.

• newHeaderValue (string; allows variables): With the action set to MODIFY, specifies an HTTP header replacement value.

• regexHeaderMatch (string; allows variables): When the action is REGEX, specifies a Perl-compatible regular expression to match within the header value.

• regexHeaderReplace (string; allows variables): When the action is REGEX, specifies text that replaces the regexHeaderMatch pattern within the header value.

• matchMultiple (boolean): When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.

• avoidDuplicateHeaders (boolean): When enabled with the action set to MODIFY, prevents creation of more than one instance of a header.

• action (enum string): Either ADD or DELETE outgoing HTTP response headers, MODIFY their fixed values, or specify a REGEX pattern to transform them.

• standardAddHeaderName (enum string): If the value of action is ADD, this specifies the name of the field to add, any of the following values:

ACCESS_CONTROL_ALLOW_CREDENTIALS
ACCESS_CONTROL_ALLOW_HEADERS
ACCESS_CONTROL_ALLOW_METHODS
ACCESS_CONTROL_ALLOW_ORIGIN
ACCESS_CONTROL_EXPOSE_HEADERS
ACCESS_CONTROL_MAX_AGE
CACHE_CONTROL
CONTENT_DISPOSITION
CONTENT_TYPE
EDGE_CONTROL
OTHER
P3P
PRAGMA

• standardDeleteHeaderName (enum string): If the value of action is DELETE, this specifies the name of the field to remove, any of the following values:

ACCESS_CONTROL_ALLOW_CREDENTIALS
ACCESS_CONTROL_ALLOW_HEADERS
ACCESS_CONTROL_ALLOW_METHODS
ACCESS_CONTROL_ALLOW_ORIGIN
ACCESS_CONTROL_EXPOSE_HEADERS
ACCESS_CONTROL_MAX_AGE
CACHE_CONTROL
CONTENT_DISPOSITION
CONTENT_TYPE
EXPIRES
OTHER
P3P
PRAGMA

• standardModifyHeaderName (enum string): If the value of action is MODIFY or REGEX, this specifies the name of the field to modify, any of the following values:

ACCESS_CONTROL_ALLOW_CREDENTIALS
ACCESS_CONTROL_ALLOW_HEADERS
ACCESS_CONTROL_ALLOW_METHODS
ACCESS_CONTROL_ALLOW_ORIGIN
ACCESS_CONTROL_EXPOSE_HEADERS
ACCESS_CONTROL_MAX_AGE
CACHE_CONTROL
CONTENT_DISPOSITION
CONTENT_TYPE
OTHER
P3P
PRAGMA

• customHeaderName (string; allows variables): Specifies a custom field name that applies when the relevant standard header name is set to OTHER.

• headerValue (string; allows variables): Specifies the existing value of the header to match.

• newHeaderValue (string; allows variables): With the action set to MODIFY, specifies the new HTTP header replacement value.

• regexHeaderMatch (string): When the action is REGEX, specifies a Perl-compatible regular expression to match within the header value.

• regexHeaderReplace (string; allows variables): When the action is REGEX, specifies text that replaces the regexHeaderMatch pattern within the header value.

• matchMultiple (boolean): When enabled with the action set to REGEX, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled.

• avoidDuplicateHeaders (boolean): When enabled with the action set to MODIFY, prevents creation of more than one instance of a header. The last header clobbers others with the same name. This option affects the entire set of outgoing headers, and is not confined to the subset of regular expression matches.

• enabled (boolean): Applies performance monitoring to this behavior’s set of content.

• requirePci (boolean): Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.

• apiKey (string): This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see Enable mPulse in Property Manager.

• bufferSize (string): Allows you to override the browser’s default (150) maximum number of reported performance timeline entries.

• configOverride (string): A JSON string representing a configuration object passed to the JavaScript library under which mPulse runs. It corresponds at run-time to the window.BOOMR_config object. For example, this turns on monitoring of Single Page App frameworks: "{\"history\": {\"enabled\": true, \"auto\": true}}". See Configuration Overrides for more information.

• enabled (boolean): Enables NetSession DLM capabilities for this content.

• enableDomain (boolean): Enables Download Manager domains.

• enableDownloadManager (boolean): When enabled, launches files once they are fully downloaded. For example, specify this option to run an executable application.

• enableDownloadClients (boolean): When enabled, allows download clients to form a peer-to-peer network to reduce transmission time.

• disableReporting (boolean): Disable download state reporting via HTTP beacon messages. Otherwise when enabled, you can view the state of each download by choosing Monitor ⇒ Download Analytics on the DLM client.

• resumeUrl (array of string values): Specify an alternate domain from which to resume a paused download. This generates a corresponding shortcut link on the end user’s desktop that disappears after the download is complete.

• organizationName (string): The name of the organization that displays in the NetSession client DLM interface.

• supportUrl (string): A supporting link to the organizationName that displays in the NetSession client DLM interface.

• behavior (enum string): If set to TWO_TIER, assessment is either Excellent or Poor. If set to THREE_TIER, the assessment can also be Fair.

• originType (enum string): Choose whether your content is retrieved from your own server (CUSTOMER), your NetStorage account (NET_STORAGE), any available Edge Load Balancing origin (EDGE_LOAD_BALANCING_ORIGIN_GROUP), a set of Application Load Balancer origins (APPLICATION_LOAD_BALANCER), a SaaS dynamic origin (SAAS_DYNAMIC_ORIGIN) if SaaS acceleration is available on your contract, or MEDIA_SERVICE_LIVE. NetStorage is most appropriate for static content.

• netStorage (object): If the originType is NET_STORAGE, this option specifies the details of the netstorage server. For example:

  "netStorage": {
      "id"                 : "netstorage_id",
      "name"               : "Example Downloads",
      "downloadDomainName" : "download.example.com",
      "cpCode"             : 12345
  }
  

• originId (string): With the originType set to EDGE_LOAD_BALANCING_ORIGIN_GROUP, identifies the Edge Load Balancing origin. This must correspond to an edgeLoadBalancingOrigin behavior’s id attribute within the same property.

• hostname (string; allows variables): With the originType set to CUSTOMER, this specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.

• mslorigin (string): With originType set to MEDIA_SERVICE_LIVE, this specifies the media’s origin server.

• saasType (enum string): With originType set to SAAS_DYNAMIC_ORIGIN, specifies the part of the request that identifies this SaaS dynamic origin, either PATH, COOKIE, QUERY_STRING, or HOSTNAME.

• saasCnameEnabled (boolean): With saasType set to HOSTNAME, enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin.

• saasCnameLevel (number): With saasType set to HOSTNAME and saasCnameEnabled on, specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.

• saasCookie (string): With the originType set to SAAS_DYNAMIC_ORIGIN and the saasType set to COOKIE, this specifies the name of the cookie that identifies this SaaS dynamic origin.

• saasQueryString (string): With the originType set to SAAS_DYNAMIC_ORIGIN and the saasType set to QUERY_STRING, this specifies the name of the query parameter that identifies this SaaS dynamic origin.

• saasRegex (string): With the originType set to SAAS_DYNAMIC_ORIGIN, this specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.

• saasReplace (string): Specifies replacement text for what saasRegex matches.

• saasSuffix (string): With the originType set to SAAS_DYNAMIC_ORIGIN, specifies the static part of the SaaS dynamic origin.

• forwardHostHeader (enum string): When the originType is set to either CUSTOMER or SAAS_DYNAMIC_ORIGIN, this specifies which Host header to pass to the origin:

  • REQUEST_HOST_HEADER passes the original request’s header.
  • ORIGIN_HOSTNAME passes the current origin’s HOSTNAME.
  • CUSTOM passes the value of customForwardHostHeader. Use this option if you want requests handled by different properties to converge on the same cached object.

• customForwardHostHeader (string; allows variables): With forwardHostHeader set to CUSTOM, this specifies the name of the custom host header the edge server should pass to the origin.

• cacheKeyHostname (enum string): With the originType set to CUSTOM, this specifies the hostname to use when forming a cache key. Specify ORIGIN_HOSTNAME if your origin server’s responses do not depend on the hostname, otherwise specify REQUEST_HOST_HEADER when using a virtual server.

• useUniqueCacheKey (boolean): With cacheKeyHostname set to ORIGIN_HOSTNAME and a shared hostname such as provided by Amazon AWS, sets a unique cache key for your content.

• compress (boolean): Enables gzip compression for non-NetStorage origins.

• enableTrueClientIp (boolean): When enabled on non-NetStorage origins, allows you to send a custom header (the trueClientIpHeader) identifying the IP address of the immediate client connecting to the edge server. This may provide more useful information than the standard X-Forward-For header, which proxies may modify.

• trueClientIpHeader (string): With enableTrueClientIp enabled, this specifies the name of the field that identifies the end client’s IP address, for example True-Client-IP.

• trueClientIpClientSetting (boolean): With enableTrueClientIp on along with this option, if a client sets the True-Client-IP header, the edge server allows it and passes the value to the origin. Otherwise the edge server removes it and sets the value itself.

• verificationMode (enum string): For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust, either PLATFORM_SETTINGS, THIRD_PARTY when your origin server references certain types of third-party hostname, or CUSTOM. The CUSTOM option only applies if the property is marked as secure. See Secure property requirements for guidance. Under some products, you may also need to enable the Secure Delivery - Customer Cert module. Contact your Akamai representative for details.

• originSni (boolean): For non-NetStorage origins, enabling this adds a Server Name Indication (SNI) header in the SSL request sent to the origin, with the origin hostname as the value. Contact your Akamai representative for more information.

• customValidCnValues (array of string values): With verificationMode set to CUSTOM, specifies values to look for in the origin certificate’s Subject Alternate Name or Common Name fields. Specify {{Origin Hostname}} and {{Forward Host Header}} within the text in the order you want them to be evaluated. (Note that these two template items are not the same as in-line variables, which use the same curly-brace syntax.)

• originCertsToHonor (enum string): With verificationMode set to CUSTOM, specifies whether to trust pinned origin server certificates (CUSTOM_CERTIFICATES), any certificate signed by an Akamai-managed authority set (STANDARD_CERTIFICATE_AUTHORITIES), or any certificate signed by a custom authority set you manage (CUSTOM_CERTIFICATE_AUTHORITIES). If set to COMBO, may rely on all three inputs.

• standardCertificateAuthorities (object): With originCertsToHonor set to either STANDARD_CERTIFICATE_AUTHORITIES or COMBO, specifies an array of Akamai-managed certificate names. Currently, the only allowed value is akamai-permissive.

• customCertificateAuthorities (object): With originCertsToHonor set to either CUSTOM_CERTIFICATE_AUTHORITIES or COMBO, specifies an array of certification objects. Contact your Akamai representative for details on this object’s requirements.

• customCertificates (object): With originCertsToHonor set to either CUSTOM_CERTIFICATES or COMBO, specifies an array of certification objects. Contact your Akamai representative for details on this object’s requirements.

• httpPort (number): Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily 80.

• httpsPort (number): Specifies the port on your origin server to which edge servers should connect for secure HTTPS requests, customarily 443. This option only applies if the property is marked as secure. See Secure property requirements for guidance.

• country (enum string): Specifies the origin’s geographic region, or UNKNOWN to defer any optimizations based on geography. Regions include GLOBAL_MULTI_GEO, EUROPE, NORDICS, GERMANY, UNITED_KINGDOM, ITALY, INDIA, JAPAN, TAIWAN, ASIA_PACIFIC, AUSTRALIA, LATIN_AMERICA, MEXICO, SOUTH_AMERICA, US_CENTRAL, US_EAST, US_WEST, NORTH_AMERICA, OTHER_AMERICAS, OTHER_APJ (Asia, Pacific, Japan), OTHER_EMEA (Europe, Middle East, Africa), or ADC for Akamai Direct Connection, available to Adaptive Media Delivery customers.

• directConnectGeo (string): With country set to ADC, provides a region used by Akamai Direct Connection.

• authenticationMethod (enum string): Specifies the authentication method, either AWSV4 (Amazon Web Services), GCP (Google Cloud Platform), or AUTOMATIC. With the Adaptive Media Delivery product, choose additional SIGNATURE_HEADER_AUTHENTICATION or MSL_AUTHENTICATION options.

• encodingVersion (numeric enum): With authenticationMethod set to SIGNATURE_HEADER_AUTHENTICATION, specifies the version of the encryption algorithm, an integer from 1 to 5.

• useCustomSignString (boolean): With authenticationMethod set to SIGNATURE_HEADER_AUTHENTICATION, specifies whether to customize your signed string.

• customSignString (array of string values): With useCustomSignString enabled, specifies the data to be encrypted as a sequence of concatenated strings. The array may include any of the following enumerated values: AK_CLIENT_REAL_IP, AK_DOMAIN, AK_EXTENSION, AK_FILENAME, AK_HOSTHEADER, AK_METHOD, AK_PATH, AK_QUERY, AK_SCHEME, and AK_URL. See Support for variables for guidance.

• secretKey (string): Specifies the shared secret key.

• nonce (string): Specifies the nonce.

• mslkey (string): With authenticationMethod set to MSL_AUTHENTICATION, specifies the access key provided by the hosting service.

• mslname (string): With authenticationMethod set to MSL_AUTHENTICATION, specifies the origin name provided by the hosting service.

• gcsAccessKeyId (string): With authenticationMethod set to GCP, specifies the access key ID provided by Google Cloud Platform.

• gcsSecretKey (string): With authenticationMethod set to GCP, specifies the bucket name for your Google Cloud Platform service.

• gcsBucket (string): With authenticationMethod set to GCP, specifies the secret key used to compute the signature.

• awsv4AccessKeyId (string): With authenticationMethod set to AWSV4, specifies the access key used to compute the signature.

• awsv4SecretKey (string): With authenticationMethod set to AWSV4, specifies the secret key AWS uses to compute the signature.

• awsv4Region (string): With authenticationMethod set to AWSV4, specifies the region on the AWS service.

• awsv4Host (string): With authenticationMethod set to AWSV4, specifies the AWS hostname, with no http:// or https:// scheme prefix.

• awsv4Service (string): With authenticationMethod set to AWSV4, specifies the AWS service name, the hostname segment that precedes amazon.com.

• origintype (enum string): Specifies AZURE or an UNKNOWN origin type.

• enabled (boolean): Enables the persistent connections behavior.

• timeout (duration string): Specifies the timeout period after which edge server closes the persistent connection with the client, 500 seconds by default.

• enabled (boolean): Enables persistent connections.

• timeout (duration string): Specifies the timeout period after which edge server closes a persistent connection.

• enabled (boolean): When enabled, marks content as personally identifiable information (PII).

• enabled (boolean): Enables the Phased Release Cloudlet.

• cloudletPolicy (object): Specifies the Cloudlet policy as an object containing two members: a descriptive name string and an integer id set by the Cloudlet application.

• label (string): A label to distinguish this Phased Release policy from any others within the same property.

• populationCookieType (enum string): For the population of users the Cloudlet defines, select whether to assign a cookie to them, or else NONE. Other option values specify when the cookie expires: after a specific DURATION, at a FIXED_DATE, once the browser session ends (ON_BROWSER_CLOSE), or NEVER. If you select the Cloudlet’s random membership option, it overrides the option value so that it is effectively NONE.

• populationExpirationDate (ISO 8601 format date/time string): With the populationCookieType set to FIXED_DATE, this specifies the date and time when membership expires, and the browser no longer sends the cookie. Subsequent requests re-evaluate based on current membership settings.

• populationDuration (duration string): With the populationCookieType set to DURATION, this sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.

• populationRefresh (boolean): With the populationCookieType set to DURATION, enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.

• failoverEnabled (boolean): Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.

• failoverResponseCode (array of string values): With failoverEnabled on, this defines the set of failure codes that initiate the failover response.

• failoverDuration (number within 0–300 range): Specifies the number of seconds to wait until the client tries to access the failover origin after the initial failure is detected. Set the value to 0 to immediately request the alternate origin upon failure.

• preconnectlist (array of string values): Specifies the set of hostnames to which to preconnect over HTTP2.

• enabled (boolean): Enables the predictive prefetching behavior.

• accuracyTarget (enum string): The level of prefetching, either LOW, MEDIUM, or HIGH. A higher level results in better client performance, but potentially greater load on the origin.

• enabled (boolean): Applies prefetching behavior when enabled.

• enabled (boolean): When enabled, allows matching content to prefetch when referenced on a requested parent page.

• enabled (boolean): Enables the cache prefreshing behavior.

• prefreshval (number within 0–99 range): Specifies when the prefresh occurs as a percentage of the TTL. For example, for an object whose cache has 10 minutes left to live, and an origin response that is routinely less than 30 seconds, a percentage of 95 prefreshes the content without unnecessarily increasing load on the origin.

• enabled (boolean): Enables QUIC support.

• quicOfferPercentage (number within 1–50 range): The percentage of responses for which to allow QUIC sessions.

• flv (boolean): Enables random seek optimization in FLV files.

• mp4 (boolean): Enables random seek optimization in MP4 files.

• maximumSize (string): With the mp4 option enabled, sets the maximum size of the MP4 file to optimize, expressed as a number suffixed with a unit string such as MB or GB.

• enabled (boolean): Enables API Gateway for the current set of content.

• value (duration string): Specifies the read timeout necessary before failing with a 504 error. This value should never be zero.

• enabled (boolean): When enabled, activates real-use monitoring.

• mobileDefaultChoice (enum string): When set to MOBILE, allows only a 302 response code. When set to DEFAULT, allows all other responseCode values.

• destinationProtocol (enum string): Choose the protocol for the redirect URL, either HTTP, HTTPS, or SAME_AS_REQUEST to pass through the original protocol.

• destinationHostname (enum string): Specify how to change the requested hostname, independently from the pathname:

  • SUBDOMAIN prepends a subdomain from the destinationHostSubdomain field.
  • SIBLING replaces the leftmost subdomain with the destinationHostSibling field.
  • OTHER specifies a static domain in the destinationHostnameOther field.
  • SAME_AS_REQUEST preserves the hostname unchanged.

• destinationHostSubdomain (string; allows variables): If destinationHostname is set to SUBDOMAIN, this specifies a subdomain to prepend to the current hostname. For example, a value of m changes www.example.com to m.www.example.com.

• destinationHostSibling (string; allows variables): If destinationHostname is set to SIBLING, this specifies the subdomain with which to replace to the current hostname’s leftmost subdomain. For example, a value of m changes www.example.com to m.example.com.

• destinationHostnameOther (string; allows variables): If destinationHostname is set to OTHER, this specifies the full hostname with which to replace the current hostname.

• destinationPath (enum string): Specify how to change the requested pathname, independently from the hostname:

  • PREFIX_REQUEST prepends a path with the destinationPathPrefix field. You also have the option to specify a suffix using destinationPathSuffix and destinationPathSuffixStatus.
  • OTHER replaces the current path with the destinationPathOther field.
  • SAME_AS_REQUEST preserves the current path unchanged.

• destinationPathPrefix (string; allows variables): When destinationPath is set to PREFIX_REQUEST, this prepends the current path. For example, a value of /prefix/path changes /example/index.html to /prefix/path/example/index.html.

• destinationPathSuffixStatus (enum string): When destinationPath is set to PREFIX_REQUEST, this gives you the option of adding a suffix. Specify NO_SUFFIX if you want to preserve the end of the path unchanged. If you specify SUFFIX, the destinationPathSuffix provides the value.

• destinationPathSuffix (string; allows variables): When destinationPath is set to PREFIX_REQUEST and destinationPathSuffixStatus is set to SUFFIX, this specifies the suffix to append to the path.

• destinationPathOther (string; allows variables): When destinationPath is set to PREFIX_REQUEST, this replaces the current path.

• queryString (enum string): When set to APPEND, passes incoming query string parameters as part of the redirect URL. Otherwise set this to IGNORE.

• responseCode (numeric enum): Specify the redirect’s response code: 301 (Moved Permanently), 302 (Found), 303 (See Other), or 307 (Temporary Redirect).

• enabled (boolean): Enables the redirect feature.

• destination (string; allows variables): Specifies the redirect as a path expression starting with a / character relative to the current root, or as a fully qualified URL. Optionally inject variables, as in this example that refers to the original request’s filename: /path/to/{{builtin.AK_FILENAME}}.

• responseCode (numeric enum): Assigns the status code for the redirect response, either 301, 302, 303, or 307.

• enabled (boolean): Enables the referer-checking behavior.

• strict (boolean): When enabled, excludes requests whose Referer header include a relative path, or that are missing a Referer. When disabled, only excludes requests whose Referer hostname is not part of the domains set.

• domains (array of string values): Specifies the set of allowed domains. With allowChildren disabled, prefixing values with *. specifies domains for which subdomains are allowed.

• allowChildren (boolean): When enabled, allows all subdomains for the domains set, just like adding a *. prefix to each.

• parameters (array of string values): Specifies parameters to remove from the request.

• enabled (boolean): When enabled, removes the Vary header to ensure objects can be cached.

• logHost (boolean): Log the Host header.

• logReferer (boolean): Log the Referer header.

• logUserAgent (boolean): Log the User-Agent header.

• logAcceptLanguage (boolean): Log the Accept-Language header.

• logCookies (enum string): With a set of defined cookie names, specifies whether you want to log ALL or SOME cookies, or to turn OFF the feature to stop logging cookies.

• cookies (array of string values): With logCookies set to SOME, this specifies the set of cookies names whose values you want to log.

• logCustomLogField (boolean): Whether to append additional custom data to each log line.

• customLogField (string; allows variables): With logCustomLogField enabled, specifies an additional data field to append to each log line, maximum 40 bytes, typically based on a dynamically generated built-in system variable. For example, round-trip: {{builtin.AK_CLIENT_TURNAROUND_TIME}}ms would log the total time to complete the response. See Support for variables for more information.

• enabled (boolean): Enables the Request Control Cloudlet.

• cloudletPolicy (object): Identifies the Cloudlet policy in an object featuring unique numeric id and descriptive string name members.

• enableBranded403 (boolean): If enabled, serves a branded 403 page for this Cloudlet instance.

• branded403StatusCode (numeric enum): Specifies the response status code for the branded deny action, either 200, 302, 403, or 503.

• netStorage (object): Specifies the NetStorage domain that contains the branded 403 page.

• branded403File (string): Specifies the full path of the branded 403 page, including the filename, but excluding the NetStorage CP code path component.

• branded403Url (string): Specifies the redirect URL for the branded deny action.

• brandedDenyCacheTtl (number within 5–30 range): Specifies the branded response page’s time to live in the cache, 5 minutes by default.

• requestType (enum string): Specifies the type of request as either DOWNLOAD or CAMPAIGN_SERVER.

• enabled (boolean): Enables the Resource Optimizer feature.

• enabled (boolean): Enables the Resource Optimizer feature.

• enableAllFeatures (boolean): Enables the full set of Resource Optimizer feature.

• statusCode (numeric enum): The HTTP status code to replace the existing one, any of the following:

100
101
102
103
122
200
201
202
203
204
205
206
207
226
300
301
302
303
304
305
306
307
308
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
422
423
424
425
426
428
429
431
444
449
450
499
500
501
502
503
504
505
506
507
509
510
511
598
599

• override206 (boolean): When enabled, allows any specified 200 success code to override a 206 partial-content code, in which case the response’s content length matches the requested range length.

• enabled (boolean): When enabled, allows you to set a response cookie.

• cookieName (string; allows variables): Specifies the name of the cookie, which serves as a key to determine if the cookie is set.

• type (enum string): Assign either a UNIQUE value, or a FIXED one based on the value field.

• value (string; allows variables): If the cookie type is FIXED, this specifies the cookie value.

• format (enum string): When the type of cookie is set to UNIQUE, set this to either APACHE or AKAMAI format. The latter format adds milliseconds to the date stamp.

• defaultDomain (boolean): When enabled, uses the default domain value, otherwise the set specified in the domain field.

• defaultPath (boolean): When enabled, uses the default path value, otherwise the set specified in the path field.

• domain (string; allows variables): If the defaultDomain is disabled, this sets the domain for which the cookie is valid. For example, example.com makes the cookie valid for that hostname and all subdomains.

• path (string; allows variables): If the defaultPath is disabled, sets the path component for which the cookie is valid.

• expires (enum string): Sets various ways to specify when the cookie expires:

  • A value of NEVER lets the cookie persist indefinitely.
  • A value of ON_BROWSER_CLOSE limits the cookie to the duration of the session.
  • A value of DURATION requires a corresponding DURATION field value.
  • A value of FIXED_DATE requires a corresponding expirationDate field value.

• expirationDate (ISO 8601 format date/time string): If expires is set to FIXED_DATE, this sets when the cookie expires as a UTC date and time.

• duration (duration string): If expires is set to DURATION, this sets the cookie’s lifetime.

• secure (boolean): When enabled, sets the cookie’s Secure flag to transmit it with HTTPS.

• maximumSize (read-only string): Specifies a fixed maximum size of non-HTML content to cache.

• responseHeaderName (string): Specifies the name of the HTTP header in which to report the cache status value.

• behavior (enum string): The action to perform on the path:

  • If set to PREPEND, specify the targetPathPrepend. For example, if set to /prefix/, /path1/page.html changes to /prefix/path1/page.html.

  • If set to REPLACE, specify the match and targetPath. For example, a match of /path1/ and a targetPath of /path1/path2/ changes /path1/page.html to /path1/path2/page.html.

  • If set to REGEX_REPLACE, specify the matchRegex and targetRegex. For example, specifying logo\\.(png|gif|jpe?g) and brand\$1 changes logo.png to brand.png.

  • If set to REWRITE, specify the targetUrl. For example, you can direct traffic to /error/restricted.html.

  • If set to REMOVE, specify the match. For example, a match of /path2/ changes /path1/path2/page.html to /path1/page.html.

• match (string): When behavior is REMOVE or REPLACE, specifies the part of the incoming path you’d like to remove or modify.

• matchRegex (string): When behavior is set to REGEX_REPLACE, specifies the Perl-compatible regular expression to replace with targetRegex.

• targetRegex (string; allows variables): When behavior is set to REGEX_REPLACE, this replaces whatever the matchRegex field matches, along with any captured sequences from \$1 through \$9.

• targetPath (string; allows variables): When behavior is set to REPLACE, this path replaces whatever the match field matches in the incoming request’s path.

• targetPathPrepend (string; allows variables): When behavior is set to PREPEND, specifies a path to prepend to the incoming request’s URL.

• targetUrl (string; allows variables): When behavior is set to REWRITE, specifies the full path to request from the origin.

• matchMultiple (boolean): When enabled, replaces all potential matches rather than only the first.

• keepQueryString (boolean): When enabled, retains the original path’s query parameters.

• rumSampleRate (number within 0–100 range): Specifies the percentage of web traffic to include in your RUM report.

• rumGroupName (string): A deprecated option to specify an alternate name under which to batch this set of web traffic in your report. Do not use it.

• applicationAction (enum string): Specifies the request component that identifies a SaaS application, either COOKIE, HOSTNAME, PATH, or QUERY_STRING. Setting it to DISABLED effectively ignores applications.

• applicationCookie (string): With applicationAction set to COOKIE, this specifies the name of the cookie that identifies the application.

• applicationQueryString (string): With applicationAction set to QUERY_STRING, this names the query parameter that identifies the application.

• applicationCnameEnabled (boolean): With applicationAction set to HOSTNAME, enabling this allows you to identify applications using a CNAME chain rather than a single hostname.

• applicationCnameLevel (number): With applicationCnameEnabled on, this specifies the number of CNAMEs to use in the chain.

• applicationRegex (string): Specifies a Perl-compatible regular expression with which to substitute the request’s application ID.

• applicationReplace (string): Specifies a string to replace the request’s application ID matched by applicationRegex.