• do_aic_mobile (boolean): When enabled, adapts images served over cellular mobile networks. (In the Beta API, please substitute "true" and "false" string values.)

• do_aic_nonmobile (boolean): When enabled, adapts images served over non-cellular networks. (In the Beta API, please substitute "true" and "false" string values.)

• standard_comp_t1_method (enum string): Specifies tier–1 non-cellular network behavior, either compress, strip, or bypass.

• standard_comp_t1_slider (number within 0–100 range): With standard_comp_t1_method set to compress, this specifies the compression percentage.

• standard_comp_t2_method (enum string): Specifies tier–2 non-cellular network behavior, either compress, strip, or bypass.

• standard_comp_t2_slider (number within 0–100 range): With standard_comp_t2_method set to compress, this specifies the compression percentage.

• standard_comp_t5_method (enum string): Specifies tier–5 non-cellular network behavior, either compress, strip, or bypass.

• standard_comp_t5_slider (number within 0–100 range): With standard_comp_t5_method set to compress, this specifies the compression percentage.

• mobile_comp_t1_method (enum string): Specifies tier–1 behavior, either compress, strip, or bypass.

• mobile_comp_t1_slider (number within 0–100 range): With mobile_comp_t1_method set to compress, this specifies the compression percentage.

• mobile_comp_t2_method (enum string): Specifies tier–2 cellular-network behavior, either compress, strip, or bypass.

• mobile_comp_t2_slider (number within 0–100 range): With mobile_comp_t2_method set to compress, this specifies the compression percentage.

• mobile_comp_t5_method (enum string): Specifies tier–5 cellular-network behavior, either compress, strip, or bypass.

• mobile_comp_t5_slider (number within 0–100 range): With mobile_comp_t5_method set to compress, this specifies the compression percentage.

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

• xml (string): Akamai XML metadata.

• status (boolean): Enables the Akamaizer behavior. (In the Beta API, please substitute "on" and "off" string values.)

• 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 tags_attr refers to:

  • attr for when tags_attr refers to a tag/attribute pair, the match only applies to the attribute.
  • urlattr is the same as attr, 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 tags_attr field and performs the substitution on the entire page.

• tags_attr (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

• behavior (enum string): Either stop to replace only one match, or continue to replace all.

• type (boolean): Whether to include or exclude what tags_attr specifies. (In the Beta API, please substitute "include" and "exclude" string values.)

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

  (In the Beta API, please substitute "on" and "off" string values.)

• 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.

• allow (boolean): When enabled, allows DELETE requests. Content does not cache. (In the Beta API, please substitute "on" and "off" string values.)

• allow (boolean): When enabled, allows PATCH requests. Content does not cache. (In the Beta API, please substitute "on" and "off" string values.)

• allow (boolean): When enabled, allows POST requests. (In the Beta API, please substitute "on" and "off" string values.)

• allow_without_content_length (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. (In the Beta API, please substitute "on" and "off" string values.)

• allow (boolean): When enabled, allows PUT requests. Content does not cache. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): Activates the API Prioritization feature. (In the Beta API, please substitute "on" and "off" string values.)

• nimbus_policy_token (string): Specifies the name of the API Prioritization policy, using alphanumeric and underscore characters.

• use_throttled_cpcode (boolean): Specifies whether to apply an alternative CP code for requests served the alternate response. (In the Beta API, please substitute "on" and "off" string values.)

• throttled_cpcode (object): With use_throttled_cpcode enabled, this specifies the CP code as an object:

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

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

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

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

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

• status (boolean): Enables the Audience Segmentation cloudlet feature. (In the Beta API, please substitute "on" and "off" string values.)

• nimbus_policy_token (object): Specifies the name of the audience segmentation policy, using alphanumeric and underscore characters. The token serves as a string prefix in forming the cookie name.

• 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, never.

• 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.

• segment_cookie_expiry_type (enum string): Specifies when the segmentation cookie expires, either on_browser_close, never, or based on a specific duration.

• segment_cookie_duration (duration string): With segment_cookie_expiry_type set to duration, specifies the lifetime of the segmentation cookie.

• rolling_segment (boolean): If disabled, sets the expiration time only if the cookie is not yet present in the request. (In the Beta API, please substitute "1" and "0" string values.)

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

• status (boolean): Enables the break connection behavior. (In the Beta API, please substitute "on" and "off" string values.)

• enabled (boolean): When enabled, activates the error-caching behavior. (In the Beta API, please substitute "true" and "false" string values.)

• 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. (In the Beta API, please substitute "on" and "off" string values.)

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

  • includehd includes specified HTTP headers in the cache ID.
  • includeck includes specified cookies in the cache ID.
  • includeallqs includes all query parameters when forming a cache ID.
  • includeqs includes the specified set of query parameters when forming a cache ID.
  • excludeqs excludes the specified set of query parameters when forming a cache ID.
  • includeurl includes the full URL, the same as the default without the cacheid behavior.

• value (enum string): If set to nameandvalue, includes the value of the specified elements in the cache ID. Otherwise if set to nameonly, 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 includeck, includeqs, includehd, or excludeqs. (In the Beta API, please substitute "on" and "off" string values.)

• elementlist (array of string values): Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID. (Only applies when the rule is includeck, includehd, includeqs, or excludeqs.)

• ignore_case (boolean): When enabled, ignores case when forming cache keys. (In the Beta API, please substitute "on" and "off" string values.)

• 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.

• exact_match (boolean): When enabled, parameters must match exactly. Keep disabled to match string prefixes. (In the Beta API, please substitute "yes" and "no" string values.)

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

• enabled (boolean): Enables caching of POST responses. (In the Beta API, please substitute "on" and "off" string values.)

• 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. (In the Beta API, please substitute "true" and "false" string values.)

• 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 cc header
  • Honor the origin’s expires header
  • Honor both the origin’s cc and expires header, whichever comes last.

• 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. (In the Beta API, please substitute "on" and "off" string values.)

• 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.

• status (boolean): Enables the centralized authorization behavior. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): When enabled, allows edge servers to chase redirects. (In the Beta API, please substitute "true" and "false" string values.)

• 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. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): When enabled, serves the custom response. Enabling the behavior evicts the cached object associated with the request, since it is not being served. (In the Beta API, please substitute "on" and "off" string values.)

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

• responsecode (enum string): The HTTP response code to send to the end-user client, either 200 or 404.

• 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–100 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.

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

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

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

• behavior (boolean): Either allow or deny access. (In the Beta API, please substitute "deny" and "allow" string values.)

• 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.

• edc_elementlist (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

• edc_elementlist (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

• status (boolean): When enabled, allows edge servers to refresh an expired DNS record after serving content. (In the Beta API, please substitute "on" and "off" string values.)

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

• status (boolean): When enabled, allows edge servers to refresh DNS records before they expire. (In the Beta API, please substitute "on" and "off" string values.)

• 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.

• status (boolean): Enables the protocol downgrading behavior. (In the Beta API, please substitute "on" and "off" string values.)

• 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 allow_behavior 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.

• allow_behavior (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.

• headers_sent (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.
  • cc-only sends only the origin’s Cache-Control header.
  • expires-only sends only the origin’s Expires header.
  • both sends Cache-Control and Expires header.
  • none strips both headers.

• send_private (boolean): When enabled, adds a Cache-Control: private header to prevent objects from being cached in a shared caching proxy. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): Enables the Edge Redirector Cloudlet. (In the Beta API, please substitute "on" and "off" string values.)

• nimbus_policy_token (string): Specifies the name of the redirect policy, using alphanumeric and underscore characters.

• publish (boolean): Enables Cloud Monitor’s log-publishing behavior. (In the Beta API, please substitute "on" and "off" string values.)

• api_connector (enum string): Describes the API connector type, either default, bmc_apm, or siem_json.

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

apm
geo
http
networkperformance
networkv1
reqheader
resheader
secappv2
secratedenyv2
secratewarnv2

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

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

• override_aggregate_settings (boolean): When enabled, overrides default log settings. (In the Beta API, please substitute "on" and "off" string values.)

• aggregate_time (duration string): With override_aggregate_settings enabled, specifies how often logs generate.

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

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

• eic_bool (boolean): Enables the edge image conversion behavior. (In the Beta API, please substitute "on" and "off" string values.)

• failover_option (boolean): If the request results in a server error, enabling this forwards it to the origin. (In the Beta API, please substitute "true" and "false" string values.)

• policy_bool (boolean): Enables a specified set of image conversion policies. (In the Beta API, please substitute "on" and "off" string values.)

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

• op_policy_violation (enum string): Specifies the HTTP error code if any op_policy_table 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.

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

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

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

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

• enable_dc_failover (boolean): When enabled, allows you to specify failover rules. (In the Beta API, please substitute "ON" and "OFF" string values.)

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

• failover_rules (array): With enable_dc_failover 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.

  (In the API’s beta version, please substitute boolean values with "true" or "false" string values.)

• 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.

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

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

• enable_session_persistence (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. (In the Beta API, please substitute "ON" and "OFF" string values.)

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

• enabled (boolean): Enables the cookie-authorization behavior. (In the Beta API, please substitute "true" and "false" string values.)

• name (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.

• status (boolean): When enabled, sends the X-Akamai-Edgescape request header to the origin. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): Enables ESI processing. (In the Beta API, please substitute "on" and "off" string values.)

• responseheaders (boolean): Enable ESI only for content featuring the following HTTP response header: Edge-control: dca=esi (In the Beta API, please substitute "on" and "off" string values.)

• passsetcookie (boolean): When enabled, allows edge servers to pass your origin server’s cookies to the ESI processor. (In the Beta API, please substitute "on" and "off" string values.)

• passsclientip (boolean): When enabled, allows edge servers to pass the client IP header to the ESI processor. (In the Beta API, please substitute "on" and "off" string values.)

• i18nstatus (boolean): When enabled, provides internationalization support for ESI. (In the Beta API, please substitute "on" and "off" string values.)

• 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.

• status (boolean): When enabled in case of a failure to contact the origin, the current behavior applies. (In the Beta API, please substitute "on" and "off" string values.)

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

  • servestale serves content that is already in the cache.
  • redirect specifies a redirect action. (Use with these options: redirecthostnametype, redirecthostname, redirectcustompath, redirectpath, redirectmethod, modifyproto, and proto.)
  • recreatedcex serves alternate content from an external network. (Use with these options: cexhostname, cexcustompath, and cexpath.)
  • recreatedco serves alternate content from your network. (Use with these options: cohostname, cocustompath, and copath.)
  • recreatedns serves NetStorage content. (Use with these options: nshostname, nspath, and cpcode.)
  • dynamic allows you to serve dynamic SaaS content. (Use with these options: dynamic_method, dynamiccustompath, saas_type, saas_suffix, saas_regex, and saas_replace.)

• cpcode (object): When type is recreatedns, 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"
  }
  

• nshostname (object): When the type is recreatedns, specifies the NetStorage origin to serve the alternate content. For example:

  "nshostname": {
      "id"                 : "id_string",
      "name"               : "Example Downloads",
      "downloadDomainName" : "example.download.akamai.com",
      "cpCode"             : 12345
  }
  

NOTE: Contact Akamai Professional Services for your NetStorage origin’s id.

• nspath (string): When the type is recreatedns, specifies the path for the NetStorage request.

• redirectmethod (enum string): When the type is redirect, specifies the HTTP response code, either 301 or 302.

• redirecthostnametype (enum string): When the type 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): When the type is redirect and the redirecthostnametype is alternate, this specifies the hostname for the redirect.

• redirectcustompath (boolean): When the type is redirect, enabling this allows you use redirectpath to customize a new path. (In the Beta API, please substitute "on" and "off" string values.)

• redirectpath (string): When the type is redirect, this specifies a new path.

• modifyproto (boolean): When the type is redirect, enabling this allows you to modify the redirect’s protocol using the value of the proto field. (In the Beta API, please substitute "on" and "off" string values.)

• proto (enum string): When the type is redirect and modifyproto is enabled, this specifies the redirect’s protocol, either HTTP or HTTPS.

• preservequerystring (boolean): When using cocustompath, cexcustompath, or redirectcustompath to specify a custom path, enabling this passes in the original request’s query string as part of the path. (In the Beta API, please substitute "on" and "off" string values.)

• cexhostname (string): When type is recreatedcex, this specifies a hostname.

• cexcustompath (boolean): When type is recreatedcex, enabling this allows you to specify a custom path. (In the Beta API, please substitute "on" and "off" string values.)

• cexpath (string): When type is recreatedcex and cexcustompath is enabled, this specifies a custom path.

• cohostname (string): When the type is recreatedco, specifies the static hostname for the alternate redirect.

• cocustompath (boolean): When the type is recreatedco, enabling this allows you to specify a custom redirect path. (In the Beta API, please substitute "on" and "off" string values.)

• copath (string): When the type is recreatedco and cocustompath is enabled, this specifies a custom redirect path.

• dynamic_method (enum string): With the type 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. (In the Beta API, please substitute "on" and "off" string values.)

• dynamicpath (string): With dynamiccustompath enabled, specifies the new path.

• saas_type (enum string): Identifies the component of the request that identifies the SaaS dynamic failaction: either cookie, hostname, path, or query_string.

• saas_suffix (string): With type set to dynamic, specifies the static portion of the SaaS dynamic failaction.

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

• saas_replace (string): With type set to dynamic, specifies the replacement pattern that defines the SaaS dynamic failaction.

• saas_cname_enabled (boolean): With the saas_type set to hostname, specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction. (In the Beta API, please substitute "on" and "off" string values.)

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

• saas_cookie (string): With saas_type set to cookie, specifies the name of the cookie that identifies this SaaS dynamic failaction.

• saas_query_string (string): With saas_type set to query_string, specifies the name of the query parameter that identifies this SaaS dynamic failaction.

• status (boolean): Enables the Forward Rewrite Cloudlet behavior. (In the Beta API, please substitute "on" and "off" string values.)

• nimbus_policy_token (string): Specifies the name of the forward rewrite policy, using alphanumeric and underscore characters.

• status (boolean): Enables the front-end optimization behavior. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): Enables the g2o verification behavior. (In the Beta API, please substitute "on" and "off" string values.)

• data_header (string): Specifies the name of the header that contains the request data that needs encryption.

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

• encoding_version (enum string): Specifies the version of the encryption algorithm as an integer string value from 1 through 5.

• sign_string_status (enum string): If set to default, the encrypted string is based on the forwarded URL. If set to custom, you can use sign_string to customize the set of data to encrypt.

• sign_string (array of string values): If the sign_string_status is set to custom, 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

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

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

• 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.

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

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

• max_reconnects (number): Specifies the maximum number of times the edge server contacts your origin server. If your origin is associated with several IP addresses, max_reconnects effectively overrides the value of ip_retrycount.

• image_management_enabled (boolean): Enable image management capabilities and generate a corresponding API token. (In the Beta API, please substitute "on" and "off" string values.)

• resize_enabled (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. (In the Beta API, please substitute "on" and "off" string values.)

• best_file_type_enabled (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. (In the Beta API, please substitute "on" and "off" string values.)

• advanced_settings_enabled (boolean): When enabled, allows you to generate a custom Image Manager API token to apply a corresponding policy to this set of images. The token consists of a descriptive label (the api_key) concatenated with a property-specific identifier that’s generated when you save the property. The API registers the token when you activate the property. (In the Beta API, please substitute "on" and "off" string values.)

• api_key (string): With the advanced_settings_enabled option activated, 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.

• api_key_default (string): Specify the default policy identifier, which is registered with the Image Manager API once you activate this property. (The advanced_settings_enabled option must be inactive.)

• enabled (boolean): Applies the Input Validation Cloudlet behavior. (In the Beta API, please substitute "true" and "false" string values.)

• 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.

• userIdentificationKeyType (enum string): Sets the method to identify unique end users, either sets of query PARAMS, sets of HTTP HEADERS, or BOTH. Series of requests that share the same set of header or parameter values identify each unique user. Blank values must remain consistently blank across the series of requests for the user to be identified.

• userIdentificationKeyHeaders (array of string values): With userIdentificationKeyType set to HEADERS or BOTH, this specifies the HTTP headers whose combined set of values identify each end user.

• userIdentificationKeyParams (array of string values): With userIdentificationKeyType set to PARAMS or BOTH, this specifies the query parameters whose combined set of values identify each end user.

• 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. (In the Beta API, please substitute "true" and "false" string values.)

• 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.

• failureAction (enum string): For invalid requests that do not yet exceed the penaltyThreshold, this specifies the response, either DENY_403 or REDIRECT_302.

• failure302Uri (string): With failureAction set to REDIRECT_302, this specifies the redirect link for invalid requests that have not yet triggered a penalty.

• failureNetStorage (object): With failureAction set to DENY_403, this specifies the NetStorage account that serves out the failure’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.

• failure403NetStoragePath (string): With failureAction set to DENY_403, this specifies the full path to the static 403 response content relative to the downloadDomainName in the failureNetStorage object.

• 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 DENY_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 DENY_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 DENY_403, this specifies the full path to the static 403 response content relative to the downloadDomainName in the penaltyNetStorage object.

• prefetch_cacheable (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. (In the Beta API, please substitute "on" and "off" string values.)

• prefetch_no_store (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 prefetch_no_store_ext option. Only applies to content with the sureRoute behavior enabled. (In the Beta API, please substitute "on" and "off" string values.)

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

• prefetch_html (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. (In the Beta API, please substitute "on" and "off" string values.)

• customize_rel_attr (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.

• status (boolean): Enables the InstantConfig behavior. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): Enables the file optimization behavior. (In the Beta API, please substitute "on" and "off" string values.)

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

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

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

• filenames_changed (boolean): When lfo_type is set to poc, 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. (In the Beta API, please substitute "on" and "off" string values.)

• option (boolean): When enabled, activates the bit rate limiting behavior. (In the Beta API, please substitute "on" and "off" string values.)

• 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"
      }
  ]
  

• status (boolean): Enables the partial-object caching behavior. (In the Beta API, please substitute "on" and "off" string values.)

• action (enum string): Either add, delete, modify, or pass incoming HTTP request headers.

• standard_add_header_name (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.

• standard_delete_header_name (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.

• standard_modify_header_name (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.

• standard_pass_header_name (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.

• custom_header_name (string): Specifies a custom field name that applies when the relevant standard header name is set to other.

• header_value (string): With the action set to add, specifies the new header value.

• new_header_value (string): With the action set to modify, supplies an HTTP header replacement value.

• multi_headers_avoidance (boolean): When enabled with the action set to modify, prevents creation of more than one instance of a header. (In the Beta API, please substitute "on" and "off" string values.)

• action (enum string): Either add, delete, modify, or pass incoming HTTP response headers.

• standard_add_header_name (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

• standard_delete_header_name (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.

• standard_modify_header_name (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.

• standard_pass_header_name (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.

• custom_header_name (string): Specifies a custom field name that applies when the relevant standard header name is set to other.

• header_value (string): With the action set to add, specifies the header’s new value.

• new_header_value (string): With the action set to modify, specifies an HTTP header replacement value.

• multi_headers_avoidance (boolean): When enabled with the action set to modify, prevents creation of more than one instance of a header. (In the Beta API, please substitute "on" and "off" string values.)

• action (enum string): Either add or delete outgoing HTTP request headers, modify their fixed values, or specify a regex pattern to transform them.

• standard_add_header_name (enum string): If the value of action is add, this specifies the name of the field to add, either user-agent or other.

• standard_delete_header_name (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.

• standard_modify_header_name (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.

• custom_header_name (string): Specifies a custom field name that applies when the relevant standard header name is set to other.

• header_value (string): With the action set to add, specifies the new header value.

• new_header_value (string): With the action set to modify, specifies an HTTP header replacement value.

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

• regex_header_replace (string): When the action is regex, specifies text that replaces the regex_header_match pattern within the header value.

• match_multiple (boolean): When enabled with the action set to regex, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. (In the Beta API, please substitute "on" and "off" string values.)

• multi_headers_avoidance (boolean): When enabled with the action set to modify, prevents creation of more than one instance of a header. (In the Beta API, please substitute "on" and "off" string values.)

• action (enum string): Either add or delete outgoing HTTP response headers, modify their fixed values, or specify a regex pattern to transform them.

• standard_add_header_name (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
pragma
P3P
other

• standard_delete_header_name (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
pragma
P3P
other

• standard_modify_header_name (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
pragma
P3P
other

• custom_header_name (string): Specifies a custom field name that applies when the relevant standard header name is set to other.

• header_value (string): Specifies the existing value of the header to match.

• new_header_value (string): With the action set to modify, specifies the new HTTP header replacement value.

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

• regex_header_replace (string): When the action is regex, specifies text that replaces the regex_header_match pattern within the header value.

• match_multiple (boolean): When enabled with the action set to regex, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. (In the Beta API, please substitute "on" and "off" string values.)

• multi_headers_avoidance (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. (In the Beta API, please substitute "on" and "off" string values.)

• netsession (boolean): Enables NetSession DLM capabilities for this content. (In the Beta API, please substitute "on" and "off" string values.)

• enable_domain (boolean): … (In the Beta API, please substitute "on" and "off" string values.)

• enable_dlm (boolean): When enabled, launches files once they fully download. For example, specify this option to run an executable application. (In the Beta API, please substitute "on" and "off" string values.)

• enable_download_clients (boolean): When enabled, allows download clients to form a peer-to-peer network to reduce transmission time. (In the Beta API, please substitute "on" and "off" string values.)

• disable_reporting (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. (In the Beta API, please substitute "on" and "off" string values.)

• resume_url (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.

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

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

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

• type (enum string): Choose whether to fetch your content from your own server (customer), your NetStorage account (netstorage), any available Edge Load Balancing origin (elb_origin_group), or a SaaS dynamic origin (saas_dynamic_origin). NetStorage is most appropriate for static content.

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

  "netstorage": {
      "id"                 : "id_string",
      "name"               : "Example Downloads",
      "downloadDomainName" : "example.download.akamai.com",
      "cpCode"             : 12345
  }
  

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

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

• saas_type (enum string): With type set to saas_dynamic_origin, specifies the part of the request that identifies this SaaS dynamic origin, either path, cookie, query_string, or hostname.

• saas_cname_enabled (boolean): With saas_type set to hostname, enabling this allows you to use a CNAME chain to determine the hostname for this SaaS dynamic origin. (In the Beta API, please substitute "on" and "off" string values.)

• saas_cname_level (number): With saas_type set to hostname and saas_cname_enabled on, specifies the desired number of hostnames to use in the CNAME chain, starting backwards from the edge server.

• saas_cookie (string): With the type set to saas_dynamic_origin and the saas_type set to cookie, this specifies the name of the cookie that identifies this SaaS dynamic origin.

• saas_query_string (string): With the type set to saas_dynamic_origin and the saas_type set to query_string, this specifies the name of the query parameter that identifies this SaaS dynamic origin.

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

• saas_replace (string): Specifies replacement text for what saas_regex matches.

• saas_suffix (string): With the type set to saas_dynamic_origin, specifies the static part of the SaaS dynamic origin.

• forwardhostheader (enum string): When the type is set to either customer or saas_dynamic_origin, this specifies which Host header to pass to the origin:

  • requesthostheader passes the original request’s header.
  • originhostname 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): 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 origin type set to custom, this specifies the hostname to use when forming a cache key. Specify originhostname if your origin server’s responses do not depend on the hostname, otherwise specify requesthostheader when using a virtual server.

• compression (boolean): Enables gzip compression for non-NetStorage origins. (In the Beta API, please substitute "on" and "off" string values.)

• tcip_enabled (boolean): When enabled on non-NetStorage origins, allows you to send a custom header (the tcip_header) 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. (In the Beta API, please substitute "on" and "off" string values.)

• tcip_header (string): With tcip_enabled on, this specifies the name of the field identifying the end client’s IP address, for example True-Client-IP.

• tcip_allow_clients_to_set (boolean): With tcip_enabled 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. (In the Beta API, please substitute "on" and "off" string values.)

• origin_cert_delegate (enum string): For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust, either delegate, warn, custom, or no_selection. (This option only applies if the property is marked as secure. See the Rules section for details on the is_secure property option.)

• origin_cert_valid_cn_other (array of string values): With origin_cert_delegate 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}} as variables in the order you want them to be evaluated.

• origin_certs_to_honor (enum string): With origin_cert_delegate set to custom, specifies whether to trust pinned origin server certificates (custom_certs), any certificate signed by an Akamai-managed authority set (standard_cas), or any certificate signed by a custom authority set you manage (custom_cas). If set to combo, may rely on all three inputs.

• origin_cert_standard_cas (object): With origin_certs_to_honor set to either standard_cas or combo, specifies an array of Akamai-managed certificate names. Currently, the only allowed value is akamai-permissive.

• origin_cert_custom_cas (object): With origin_certs_to_honor set to either custom_cas or combo, specifies an array of certification objects. Contact your Akamai representative for details on this object’s requirements.

• origin_cert_custom_certs (object): With origin_certs_to_honor set to either custom_certs or combo, specifies an array of certification objects. Contact your Akamai representative for details on this object’s requirements.

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

• https_port (string): 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 [Rule Behaviors][xi_rulebehaviors] for details on the is_secure property option.)

• status (boolean): Enables the persistent connections behavior. (In the Beta API, please substitute "on" and "off" string values.)

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

• status (boolean): Enables persistent connections. (In the Beta API, please substitute "on" and "off" string values.)

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

• treat_as_pii (boolean): When enabled, marks content as personally identifiable information (PII). (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): Enables the predictive prefetching behavior. (In the Beta API, please substitute "on" and "off" string values.)

• accuracy-target (enum string): The level of prefetching, either low, med, or high. A higher level results in better client performance, but potentially greater load on the origin.

• enabled (boolean): Applies prefetching behavior when enabled. (In the Beta API, please substitute "on" and "off" string values.)

• enabled (boolean): When enabled, allows matching content to prefetch when referenced on a requested parent page. (In the Beta API, please substitute "on" and "off" string values.)

• enabled (boolean): Enables the cache prefreshing behavior. (In the Beta API, please substitute "true" and "false" string values.)

• prefreshval (number within 0–100 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.

• flv (boolean): Enables random seek optimization in FLV files. (In the Beta API, please substitute "true" and "false" string values.)

• mp4 (boolean): Enables random seek optimization in MP4 files. (In the Beta API, please substitute "true" and "false" string values.)

• max_size (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.

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

• status (boolean): When enabled, activates real-use monitoring. (In the Beta API, please substitute "on" and "off" string values.)

• mobile_default_choice (enum string): When set to mobile, allows only a 302 response code. When set to default, allows all other responseCode values.

• destination_protocol (enum string): Choose the protocol for the redirect URL, either http, https, or same_as_request to pass through the original protocol.

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

  • subdomain prepends a subdomain from the destination_host_subdomain field.
  • sibling replaces the leftmost subdomain with the destination_host_sibling field.
  • other specifies a static domain in the destination_host_other field.
  • same_as_request preserves the hostname unchanged.

• destination_host_subdomain (string): If destination_host 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.

• destination_host_sibling (string): If destination_host 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.

• destination_host_other (string): If destination_host is set to other, this specifies the full hostname with which to replace the current hostname.

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

  • prefix_request prepends a path with the destination_path_prefix field. You also have the option to specify a suffix using destination_path_suffix and destination_path_suffix_status.
  • other replaces the current path with the destination_path_other field.
  • same_as_request preserves the current path unchanged.

• destination_path_prefix (string): When destination_path 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.

• destination_path_suffix_status (enum string): When destination_path 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 destination_path_suffix provides the value.

• destination_path_suffix (string): When destination_path is set to prefix_request and destination_path_suffix_status is set to suffix, this specifies the suffix to append to the path.

• destination_path_other (string): When destination_path is set to prefix_request, this replaces the current path.

• queryString (boolean): When enabled, passes incoming query string parameters as part of the redirect URL. (In the Beta API, please substitute "ignore" and "append" string values.)

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

• status (boolean): Enables the referer-checking behavior. (In the Beta API, please substitute "on" and "off" string values.)

• 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 domain set. (In the Beta API, please substitute "on" and "off" string values.)

• domain (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 domain set, just like adding a *. prefix to each. (In the Beta API, please substitute "on" and "off" string values.)

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

• remove_vary (boolean): When enabled, removes the Vary header to ensure objects can be cached. (In the Beta API, please substitute "on" and "off" string values.)

• host_enabled (boolean): Log the Host header. (In the Beta API, please substitute "on" and "off" string values.)

• referer_enabled (boolean): Log the Referer header. (In the Beta API, please substitute "on" and "off" string values.)

• useragent_enabled (boolean): Log the User-Agent header. (In the Beta API, please substitute "on" and "off" string values.)

• acceptlang_enabled (boolean): Log the Accept-Language header. (In the Beta API, please substitute "on" and "off" string values.)

• cookie_mode (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 cookie_mode set to some, this specifies the set of cookies names whose values you want to log.

• status (boolean): Enables the Request Control Cloudlet. (In the Beta API, please substitute "on" and "off" string values.)

• nimbus_policy_token (string): Specifies the name of the Request Control policy, using alphanumeric and underscore characters.

• enable_branded_403 (boolean): If enabled, serves a branded 403 page for this Cloudlet instance. (In the Beta API, please substitute "true" and "false" string values.)

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

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

• statuscode (enum string): 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.

• enable206override (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. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): When enabled, allows you to set a response cookie. (In the Beta API, please substitute "on" and "off" string values.)

• name (string): 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): 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 (enum string): Either use the default domain, or a specific one from the domain fields.

• defaultPath (enum string): Either use the default path value, or a specific one from the path field.

• domain (string): If the defaultdompath is set to specific, 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): If the defaultdompath is set to specific, 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 expiration_date field value.

• expiration_date (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. (In the Beta API, please substitute "on" and "off" string values.)

• html_disabled (read-only string): Disables edge caching for HTML content.

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

• 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 trigger and targetpath. For example, a trigger of /path1/ and a targetpath of /path1/path2/ changes /path1/page.html to /path1/path2/page.html.

  • If set to regexreplace, specify the triggerregex 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 trigger. For example, a trigger of /path2/ changes /path1/path2/page.html to /path1/page.html.

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

• triggerregex (string): When behavior is set to regexreplace, specifies the Perl-compatible regular expression to replace with targetregex.

• targetregex (string): When behavior is set to regexreplace, this replaces whatever the triggerregex field matches, along with any captured sequences from \$1 through \$9.

• targetpath (string): When behavior is set to replace, this path replaces whatever the trigger field matches in the incoming request’s path.

• targetpathprepend (string): When behavior is set to prepend, specifies a path to prepend to the incoming request’s URL.

• targeturl (string): When behavior is set to rewrite, specifies the full path to request from the origin.

• match_multiple (boolean): When enabled, replaces all potential matches rather than only the first. (In the Beta API, please substitute "on" and "off" string values.)

• keepqs (boolean): When enabled, retains the original path’s query parameters. (In the Beta API, please substitute "on" and "off" string values.)

• application_action (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.

• application_cookie (string): With application_action set to cookie, this specifies the name of the cookie that identifies the application.

• application_query_string (string): With application_action set to query_string, this names the query parameter that identifies the application.

• application_cname_enabled (boolean): With application_action set to hostname, enabling this allows you to identify applications using a CNAME chain rather than a single hostname. (In the Beta API, please substitute "on" and "off" string values.)

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

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

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

• customer_action (enum string): Specifies the request component that identifies a SaaS customer, either cookie, hostname, path, or query_string. Setting it to disabled effectively ignores customers.

• customer_cookie (string): With customer_action set to cookie, this specifies the name of the cookie that identifies the customer.

• customer_query_string (string): With customer_action set to query_string, this names the query parameter that identifies the customer.

• customer_cname_enabled (boolean): With customer_action set to hostname, enabling this allows you to identify customers using a CNAME chain rather than a single hostname. (In the Beta API, please substitute "on" and "off" string values.)

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

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

• customer_replace (string): Specifies a string to replace the request’s customer ID matched by customer_regex.

• users_action (enum string): Specifies the request component that identifies a SaaS user, either cookie, hostname, path, or query_string. Setting it to disabled effectively ignores users.

• users_cookie (string): With users_action set to cookie, this specifies the name of the cookie that identifies the user.

• users_query_string (string): With users_action set to query_string, this names the query parameter that identifies the user.

• users_cname_enabled (boolean): With users_action set to hostname, enabling this allows you to identify users using a CNAME chain rather than a single hostname. (In the Beta API, please substitute "on" and "off" string values.)

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

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

• users_replace (string): Specifies a string to replace the request’s user ID matched by users_regex.

• enabled (boolean): Enables processing of POST requests. (In the Beta API, please substitute "on" and "off" string values.)

• start (ISO 8601 format date/time string): The UTC date and time when matching cached content is to expire.

• repetition_enabled (boolean): When enabled, invalidation recurs periodically from the start time based on the repeatinterval time. (In the Beta API, please substitute "unchecked" and "checked" string values.)

• repeatinterval (duration string): With repetition_enabled on, specifies how often to invalidate content from the start time, expressed in seconds. For example, an expiration set to midnight and an interval of 86400 seconds invalidates content once a day.

NOTE: Repeating intervals of less than 5 minutes are not allowed for NetStorage origins.

• refresh_method (enum string): Specifies how to invalidate the content. Setting it to invalidate sends an If-Modified-Since request to the origin, re-caching the content only if it is fresher. Setting it to purge re-caches content regardless of its freshness, potentially creating more traffic at the origin.

• segmentedcontentprotectionswitch (boolean): Enables the segmented content protection behavior. (In the Beta API, please substitute "on" and "off" string values.)

• key (string): Specifies the encryption key to use as a shared secret to validate tokens.

• show_advanced (boolean): When enabled, allows you to specify advanced transitionKey and salt options. (In the Beta API, please substitute "true" and "false" string values.)

• transitionKey (string): An alternate encryption key to match along with the key field, allowing you to rotate keys with no down time.

• salt (string): Specifies a salt as input into the token for added security. This value must match the salt used in the token generation code.

• failureResponse (enum string): Either verifyanddeny or verifyonly.

• behavior (enum string): Set to either cached on_demand, or streaming live. (Only on_demand is allowed for NetStorage origins.)

• error_type (enum string): Specifies the type of error, any of the following:

err_connect_fail
err_connect_timeout
err_dns_fail
err_dns_in_region
err_dns_timeout
err_no_good_fwd_ip
err_read_error
err_read_timeout
err_sureroute_dns_fail
err_write_error

• timeout (duration string): When the error_type is err_connect_timeout, err_dns_timeout, err_sureroute_dns_fail, or err_read_timeout, generates an error after the specified amount of time from the initial request.

• ssmap (string): The hostname that identifies the SiteShield map, available from your Akamai representative.

• dynamicpolicy (boolean): Allows the Content Policy API to dynamically modify content. (In the Beta API, please substitute "true" and "false" string values.)

• origin (boolean): Allows you to set the origin host. (In the Beta API, please substitute "true" and "false" string values.)

• caching (boolean): Allows you to modify content caching rules. (In the Beta API, please substitute "true" and "false" string values.)

• referrer (boolean): Allows you to set the referrer whitelist or blacklist. (In the Beta API, please substitute "true" and "false" string values.)

• ip (boolean): Allows you to specify an IP whitelist or blacklist. (In the Beta API, please substitute "true" and "false" string values.)

• geo (boolean): Allows you to specify a location-based whitelist or blacklist. (In the Beta API, please substitute "true" and "false" string values.)

• contentrefresh (boolean): Allows you to schedule when custom content is to revalidate. (In the Beta API, please substitute "true" and "false" string values.)

• modifypath (boolean): Allows you to modify the request path. (In the Beta API, please substitute "true" and "false" string values.)

• cachekey (boolean): Allows you to set which query parameters are included in the cache key. (In the Beta API, please substitute "true" and "false" string values.)

• sr_enabled (boolean): Enables the SureRoute behavior, to optimize delivery of non-cached content. (In the Beta API, please substitute "true" and "false" string values.)

• sr_type (enum string): Specifies the set of edge servers used to test routes, either the default performance or a custommap that must be provided to you by Akamai Professional Services.

• custom_map (string): If sr_type is custommap, this specifies the map string provided to you by Akamai Professional Services, or included as part of the SiteShield product.

• sr_test_object_url (string): Specifies the path and filename for your origin’s test object to use in races to test routes.

  Akamai provides sample test objects for the Dynamic Site Accelerator and Web Application Accelerator products. If you want to use your own test object, it needs to be on the same origin server as the traffic being served through SureRoute. Make sure it returns a 200 HTTP response and does not require authentication. The file should be an average-sized static HTML file (Content-Type: text/html) that is no smaller than 8KB, with no back-end processing.

NOTE: If you have more than one origin server deployed behind a load balancer, you can configure it to serve the test object directly on behalf of the origin, or route requests to the same origin server to avoid deploying the test object on each origin server.

• sr_to_host_status (enum string): If set to incoming_hh, uses the incoming Host header when requesting the SureRoute test object. If set to other, use sr_to_host to specify a custom Host header.

• sr_to_host (string): If sr_to_host_status is other, this specifies the custom Host header to use when requesting the SureRoute test object.

• sr_race_stat_ttl (duration string): Specifies the time-to-live to preserve SureRoute race results, typically 30m. If traffic exceeds a certain threshold after TTL expires, the overflow is routed directly to the origin, not necessarily optimally. If traffic remains under the threshold, the route is determined by the winner of the most recent race.

• sr_force_ssl_fw (boolean): Forces SureRoute to use SSL when requesting the origin’s test object, appropriate if your origin does not respond to HTTP requests, or responds with a redirect to HTTPS. (In the Beta API, please substitute "true" and "false" string values.)

• sr_stat_key_mode (enum string): When set to default, caches race results under the race destination’s hostname. If set to custom, use custom_stat_key to specify a custom hostname.

• custom_stat_key (string): With sr_stat_key_mode set to custom, this specifies a hostname under which to cache race results. This may be useful when a property corresponds to many origin hostnames. By default, SureRoute would launch races for each origin, but consolidating under a single hostname runs only one race.

• status (boolean): When enabled, activates tiered distribution. (In the Beta API, please substitute "true" and "false" string values.)

• tdmap (enum string): Optionally map the tiered parent server’s location close to your origin: cheu2 for Europe; chaus for Australia; chapac for China and the Asian Pacific area; chwus2, chcus2, and cheus2 for different parts of the United States. Choose ch or ch2 for more global map. A narrower local map minimizes the origin server’s load, and increases the likelihood the requested object is cached. A wider global map reduces end-user latency, but decreases the likelihood the requested object is in any given parent server’s cache. (This option cannot apply if the property is marked as secure. See [Rule Behaviors][xi_rulebehaviors] for details on the is_secure property option.)

• timeout (duration string): Specifies the timeout, for example 10s.

• enabled (boolean): Enables the ETag validation behavior. (In the Beta API, please substitute "true" and "false" string values.)

• show_advanced (boolean): If enabled, allows you to specify advanced options such as algorithm, escapeHmacInputs, ignoreQueryString, transitionKey, and salt. (In the Beta API, please substitute "true" and "false" string values.)

• location (enum string): Specifies where to find the token in the incoming request, either Client_Request_Header, Query_String, or Cookie.

• locationId (string): When location is Client_Request_Header, specifies the name of the incoming request’s header where to find the token.

• algorithm (enum string): With show_advanced enabled, specifies the algorithm that generates the token, either SHA256, SHA1, or MD5, in order of descending security. It must match the method chosen in the token generation code.

• escapeHmacInputs (boolean): With show_advanced enabled, URL-escapes HMAC inputs passed in as query parameters. (In the Beta API, please substitute "on" and "off" string values.)

• ignoreQueryString (boolean): With show_advanced enabled, enabling this removes the query string from the URL used to form an encryption key. (In the Beta API, please substitute "true" and "false" string values.)

• key (string): The shared secret used to validate tokens, which must match the key used in the token generation code.

• transitionKey (string): With show_advanced enabled, specifies a transition key as a hex value.

• salt (string): With show_advanced enabled, specifies a salt string for input when generating the token, which must match the salt value used in the token generation code.

• failureResponse (boolean): When enabled, sends an HTTP error when an authentication test fails. (In the Beta API, please substitute "on" and "off" string values.)

• status (boolean): Enables the Visitor Prioritization behavior. (In the Beta API, please substitute "on" and "off" string values.)

• nimbus_policy_token (string): Specifies the Cloudlets policy name, available in Luna’s Cloudlets Policy Manager.

• throttled_response_code (enum string): Specifies the response code for requests sent to the waiting room, either 200 or 503.

• use_throttled_cpcode (boolean): When enabled, allows you to assign a different CP code that tracks any requests that are sent to the waiting room. (In the Beta API, please substitute "on" and "off" string values.)

• throttled_cpcode (object): With use_throttled_cpcode enabled, specifies a cpcode object for requests sent to the waiting room, including a numeric id key and a descriptive name:

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

• netstorage (object): Specifies the NetStorage domain for the waiting room page. For example:

  "nshostname": {
      "id"                 : "id_string",
      "name"               : "Example Downloads",
      "downloadDomainName" : "example.download.akamai.com",
      "cpCode"             : 12345
  }
  

• wr_directory (string): Specifies the NetStorage directory that contains the static waiting room page, with no trailing slash character.

• label (string): Specify a suffix to add to the Cloudlet policy’s cookies, potentially useful to distinguish one policy from another within the same property.

• wr_cookie_expiry_seconds (number within 0–100 range): Specifies the duration of the Cloudlet’s cookie that holds users in the waiting room. (It sends users back to the waiting room if they refresh the waiting room page.)

• privileged_cookie_expiry_seconds (number within 0–100 range): Specifies the duration of the privilege cookie, which bypasses Visitor Prioritization for subsequent requests once a user has been allowed through to the site.

• rolling_privilege_window (boolean): If enabled, users receive a fresh cookie that matches the duration of the Allowed User Cookie. Disable to set a fixed cookie time. (In the Beta API, please substitute "1" and "0" string values.)

• token (string): Specifies the string token.

• image_url (string): Specifies the URL for the watermark image.

• wafconfig (object): An object featuring details about your firewall configuration, for example:

  "wafconfig": {
      "configId"          : 1,
      "productionStatus"  : "Active",
      "productionVersion" : 1,
      "stagingStatus"     : "Active",
      "stagingVersion"    : 1
  }
  

• status (boolean): Enables the WebDAV behavior. (In the Beta API, please substitute "on" and "off" string values.)