akamai.getPropertyRulesBuilder
Explore with Pulumi AI
Using getPropertyRulesBuilder
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPropertyRulesBuilder(args: GetPropertyRulesBuilderArgs, opts?: InvokeOptions): Promise<GetPropertyRulesBuilderResult>
function getPropertyRulesBuilderOutput(args: GetPropertyRulesBuilderOutputArgs, opts?: InvokeOptions): Output<GetPropertyRulesBuilderResult>
def get_property_rules_builder(rules_v20230105: Optional[GetPropertyRulesBuilderRulesV20230105] = None,
rules_v20230530: Optional[GetPropertyRulesBuilderRulesV20230530] = None,
rules_v20230920: Optional[GetPropertyRulesBuilderRulesV20230920] = None,
rules_v20231030: Optional[GetPropertyRulesBuilderRulesV20231030] = None,
rules_v20240109: Optional[GetPropertyRulesBuilderRulesV20240109] = None,
rules_v20240212: Optional[GetPropertyRulesBuilderRulesV20240212] = None,
rules_v20240531: Optional[GetPropertyRulesBuilderRulesV20240531] = None,
rules_v20240813: Optional[GetPropertyRulesBuilderRulesV20240813] = None,
rules_v20241021: Optional[GetPropertyRulesBuilderRulesV20241021] = None,
rules_v20250113: Optional[GetPropertyRulesBuilderRulesV20250113] = None,
opts: Optional[InvokeOptions] = None) -> GetPropertyRulesBuilderResult
def get_property_rules_builder_output(rules_v20230105: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20230105Args]] = None,
rules_v20230530: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20230530Args]] = None,
rules_v20230920: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20230920Args]] = None,
rules_v20231030: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20231030Args]] = None,
rules_v20240109: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20240109Args]] = None,
rules_v20240212: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20240212Args]] = None,
rules_v20240531: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20240531Args]] = None,
rules_v20240813: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20240813Args]] = None,
rules_v20241021: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20241021Args]] = None,
rules_v20250113: Optional[pulumi.Input[GetPropertyRulesBuilderRulesV20250113Args]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPropertyRulesBuilderResult]
func GetPropertyRulesBuilder(ctx *Context, args *GetPropertyRulesBuilderArgs, opts ...InvokeOption) (*GetPropertyRulesBuilderResult, error)
func GetPropertyRulesBuilderOutput(ctx *Context, args *GetPropertyRulesBuilderOutputArgs, opts ...InvokeOption) GetPropertyRulesBuilderResultOutput
> Note: This function is named GetPropertyRulesBuilder
in the Go SDK.
public static class GetPropertyRulesBuilder
{
public static Task<GetPropertyRulesBuilderResult> InvokeAsync(GetPropertyRulesBuilderArgs args, InvokeOptions? opts = null)
public static Output<GetPropertyRulesBuilderResult> Invoke(GetPropertyRulesBuilderInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPropertyRulesBuilderResult> getPropertyRulesBuilder(GetPropertyRulesBuilderArgs args, InvokeOptions options)
public static Output<GetPropertyRulesBuilderResult> getPropertyRulesBuilder(GetPropertyRulesBuilderArgs args, InvokeOptions options)
fn::invoke:
function: akamai:index/getPropertyRulesBuilder:getPropertyRulesBuilder
arguments:
# arguments dictionary
The following arguments are supported:
- Rules
V20230105 GetProperty Rules Builder Rules V20230105 - Rules
V20230530 GetProperty Rules Builder Rules V20230530 - Rules
V20230920 GetProperty Rules Builder Rules V20230920 - Rules
V20231030 GetProperty Rules Builder Rules V20231030 - Rules
V20240109 GetProperty Rules Builder Rules V20240109 - Rules
V20240212 GetProperty Rules Builder Rules V20240212 - Rules
V20240531 GetProperty Rules Builder Rules V20240531 - Rules
V20240813 GetProperty Rules Builder Rules V20240813 - Rules
V20241021 GetProperty Rules Builder Rules V20241021 - Rules
V20250113 GetProperty Rules Builder Rules V20250113
- Rules
V20230105 GetProperty Rules Builder Rules V20230105 - Rules
V20230530 GetProperty Rules Builder Rules V20230530 - Rules
V20230920 GetProperty Rules Builder Rules V20230920 - Rules
V20231030 GetProperty Rules Builder Rules V20231030 - Rules
V20240109 GetProperty Rules Builder Rules V20240109 - Rules
V20240212 GetProperty Rules Builder Rules V20240212 - Rules
V20240531 GetProperty Rules Builder Rules V20240531 - Rules
V20240813 GetProperty Rules Builder Rules V20240813 - Rules
V20241021 GetProperty Rules Builder Rules V20241021 - Rules
V20250113 GetProperty Rules Builder Rules V20250113
- rules
V20230105 GetProperty Rules Builder Rules V20230105 - rules
V20230530 GetProperty Rules Builder Rules V20230530 - rules
V20230920 GetProperty Rules Builder Rules V20230920 - rules
V20231030 GetProperty Rules Builder Rules V20231030 - rules
V20240109 GetProperty Rules Builder Rules V20240109 - rules
V20240212 GetProperty Rules Builder Rules V20240212 - rules
V20240531 GetProperty Rules Builder Rules V20240531 - rules
V20240813 GetProperty Rules Builder Rules V20240813 - rules
V20241021 GetProperty Rules Builder Rules V20241021 - rules
V20250113 GetProperty Rules Builder Rules V20250113
- rules
V20230105 GetProperty Rules Builder Rules V20230105 - rules
V20230530 GetProperty Rules Builder Rules V20230530 - rules
V20230920 GetProperty Rules Builder Rules V20230920 - rules
V20231030 GetProperty Rules Builder Rules V20231030 - rules
V20240109 GetProperty Rules Builder Rules V20240109 - rules
V20240212 GetProperty Rules Builder Rules V20240212 - rules
V20240531 GetProperty Rules Builder Rules V20240531 - rules
V20240813 GetProperty Rules Builder Rules V20240813 - rules
V20241021 GetProperty Rules Builder Rules V20241021 - rules
V20250113 GetProperty Rules Builder Rules V20250113
- rules_
v20230105 GetProperty Rules Builder Rules V20230105 - rules_
v20230530 GetProperty Rules Builder Rules V20230530 - rules_
v20230920 GetProperty Rules Builder Rules V20230920 - rules_
v20231030 GetProperty Rules Builder Rules V20231030 - rules_
v20240109 GetProperty Rules Builder Rules V20240109 - rules_
v20240212 GetProperty Rules Builder Rules V20240212 - rules_
v20240531 GetProperty Rules Builder Rules V20240531 - rules_
v20240813 GetProperty Rules Builder Rules V20240813 - rules_
v20241021 GetProperty Rules Builder Rules V20241021 - rules_
v20250113 GetProperty Rules Builder Rules V20250113
getPropertyRulesBuilder Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Json string
- Rule
Format string - Rules
V20230105 GetProperty Rules Builder Rules V20230105 - Rules
V20230530 GetProperty Rules Builder Rules V20230530 - Rules
V20230920 GetProperty Rules Builder Rules V20230920 - Rules
V20231030 GetProperty Rules Builder Rules V20231030 - Rules
V20240109 GetProperty Rules Builder Rules V20240109 - Rules
V20240212 GetProperty Rules Builder Rules V20240212 - Rules
V20240531 GetProperty Rules Builder Rules V20240531 - Rules
V20240813 GetProperty Rules Builder Rules V20240813 - Rules
V20241021 GetProperty Rules Builder Rules V20241021 - Rules
V20250113 GetProperty Rules Builder Rules V20250113
- Id string
- The provider-assigned unique ID for this managed resource.
- Json string
- Rule
Format string - Rules
V20230105 GetProperty Rules Builder Rules V20230105 - Rules
V20230530 GetProperty Rules Builder Rules V20230530 - Rules
V20230920 GetProperty Rules Builder Rules V20230920 - Rules
V20231030 GetProperty Rules Builder Rules V20231030 - Rules
V20240109 GetProperty Rules Builder Rules V20240109 - Rules
V20240212 GetProperty Rules Builder Rules V20240212 - Rules
V20240531 GetProperty Rules Builder Rules V20240531 - Rules
V20240813 GetProperty Rules Builder Rules V20240813 - Rules
V20241021 GetProperty Rules Builder Rules V20241021 - Rules
V20250113 GetProperty Rules Builder Rules V20250113
- id String
- The provider-assigned unique ID for this managed resource.
- json String
- rule
Format String - rules
V20230105 GetProperty Rules Builder Rules V20230105 - rules
V20230530 GetProperty Rules Builder Rules V20230530 - rules
V20230920 GetProperty Rules Builder Rules V20230920 - rules
V20231030 GetProperty Rules Builder Rules V20231030 - rules
V20240109 GetProperty Rules Builder Rules V20240109 - rules
V20240212 GetProperty Rules Builder Rules V20240212 - rules
V20240531 GetProperty Rules Builder Rules V20240531 - rules
V20240813 GetProperty Rules Builder Rules V20240813 - rules
V20241021 GetProperty Rules Builder Rules V20241021 - rules
V20250113 GetProperty Rules Builder Rules V20250113
- id string
- The provider-assigned unique ID for this managed resource.
- json string
- rule
Format string - rules
V20230105 GetProperty Rules Builder Rules V20230105 - rules
V20230530 GetProperty Rules Builder Rules V20230530 - rules
V20230920 GetProperty Rules Builder Rules V20230920 - rules
V20231030 GetProperty Rules Builder Rules V20231030 - rules
V20240109 GetProperty Rules Builder Rules V20240109 - rules
V20240212 GetProperty Rules Builder Rules V20240212 - rules
V20240531 GetProperty Rules Builder Rules V20240531 - rules
V20240813 GetProperty Rules Builder Rules V20240813 - rules
V20241021 GetProperty Rules Builder Rules V20241021 - rules
V20250113 GetProperty Rules Builder Rules V20250113
- id str
- The provider-assigned unique ID for this managed resource.
- json str
- rule_
format str - rules_
v20230105 GetProperty Rules Builder Rules V20230105 - rules_
v20230530 GetProperty Rules Builder Rules V20230530 - rules_
v20230920 GetProperty Rules Builder Rules V20230920 - rules_
v20231030 GetProperty Rules Builder Rules V20231030 - rules_
v20240109 GetProperty Rules Builder Rules V20240109 - rules_
v20240212 GetProperty Rules Builder Rules V20240212 - rules_
v20240531 GetProperty Rules Builder Rules V20240531 - rules_
v20240813 GetProperty Rules Builder Rules V20240813 - rules_
v20241021 GetProperty Rules Builder Rules V20241021 - rules_
v20250113 GetProperty Rules Builder Rules V20250113
- id String
- The provider-assigned unique ID for this managed resource.
- json String
- rule
Format String - rules
V20230105 Property Map - rules
V20230530 Property Map - rules
V20230920 Property Map - rules
V20231030 Property Map - rules
V20240109 Property Map - rules
V20240212 Property Map - rules
V20240531 Property Map - rules
V20240813 Property Map - rules
V20241021 Property Map - rules
V20250113 Property Map
Supporting Types
GetPropertyRulesBuilderRulesV20230105
- Name string
- The name of a rule
- Advanced
Override string - XML metadata of the rule
- Behaviors
List<Get
Property Rules Builder Rules V20230105Behavior> - The list of behaviors for a rule
- Childrens List<string>
- A list of child rules for a particular rule in JSON format
- Comments string
- The comments for a rule
- Criteria
Locked bool - States whether changes to 'criterion' objects are prohibited
- Criteria
Must stringSatisfy - States whether 'all' criteria need to match or 'any'
- Criterions
List<Get
Property Rules Builder Rules V20230105Criterion> - The list of criteria for a rule
- Custom
Override GetProperty Rules Builder Rules V20230105Custom Override - XML metadata of the rule
- Is
Secure bool - States whether a rule is secure
- Template
Link string - The template link for the rule
- Template
Uuid string - The UUID of a rule template
- Uuid string
- The UUID of the rule
- Variables
List<Get
Property Rules Builder Rules V20230105Variable> - A list of variables for a rule
- Name string
- The name of a rule
- Advanced
Override string - XML metadata of the rule
- Behaviors
[]Get
Property Rules Builder Rules V20230105Behavior - The list of behaviors for a rule
- Childrens []string
- A list of child rules for a particular rule in JSON format
- Comments string
- The comments for a rule
- Criteria
Locked bool - States whether changes to 'criterion' objects are prohibited
- Criteria
Must stringSatisfy - States whether 'all' criteria need to match or 'any'
- Criterions
[]Get
Property Rules Builder Rules V20230105Criterion - The list of criteria for a rule
- Custom
Override GetProperty Rules Builder Rules V20230105Custom Override - XML metadata of the rule
- Is
Secure bool - States whether a rule is secure
- Template
Link string - The template link for the rule
- Template
Uuid string - The UUID of a rule template
- Uuid string
- The UUID of the rule
- Variables
[]Get
Property Rules Builder Rules V20230105Variable - A list of variables for a rule
- name String
- The name of a rule
- advanced
Override String - XML metadata of the rule
- behaviors
List<Get
Property Rules Builder Rules V20230105Behavior> - The list of behaviors for a rule
- childrens List<String>
- A list of child rules for a particular rule in JSON format
- comments String
- The comments for a rule
- criteria
Locked Boolean - States whether changes to 'criterion' objects are prohibited
- criteria
Must StringSatisfy - States whether 'all' criteria need to match or 'any'
- criterions
List<Get
Property Rules Builder Rules V20230105Criterion> - The list of criteria for a rule
- custom
Override GetProperty Rules Builder Rules V20230105Custom Override - XML metadata of the rule
- is
Secure Boolean - States whether a rule is secure
- template
Link String - The template link for the rule
- template
Uuid String - The UUID of a rule template
- uuid String
- The UUID of the rule
- variables
List<Get
Property Rules Builder Rules V20230105Variable> - A list of variables for a rule
- name string
- The name of a rule
- advanced
Override string - XML metadata of the rule
- behaviors
Get
Property Rules Builder Rules V20230105Behavior[] - The list of behaviors for a rule
- childrens string[]
- A list of child rules for a particular rule in JSON format
- comments string
- The comments for a rule
- criteria
Locked boolean - States whether changes to 'criterion' objects are prohibited
- criteria
Must stringSatisfy - States whether 'all' criteria need to match or 'any'
- criterions
Get
Property Rules Builder Rules V20230105Criterion[] - The list of criteria for a rule
- custom
Override GetProperty Rules Builder Rules V20230105Custom Override - XML metadata of the rule
- is
Secure boolean - States whether a rule is secure
- template
Link string - The template link for the rule
- template
Uuid string - The UUID of a rule template
- uuid string
- The UUID of the rule
- variables
Get
Property Rules Builder Rules V20230105Variable[] - A list of variables for a rule
- name str
- The name of a rule
- advanced_
override str - XML metadata of the rule
- behaviors
Sequence[Get
Property Rules Builder Rules V20230105Behavior] - The list of behaviors for a rule
- childrens Sequence[str]
- A list of child rules for a particular rule in JSON format
- comments str
- The comments for a rule
- criteria_
locked bool - States whether changes to 'criterion' objects are prohibited
- criteria_
must_ strsatisfy - States whether 'all' criteria need to match or 'any'
- criterions
Sequence[Get
Property Rules Builder Rules V20230105Criterion] - The list of criteria for a rule
- custom_
override GetProperty Rules Builder Rules V20230105Custom Override - XML metadata of the rule
- is_
secure bool - States whether a rule is secure
- template_
link str - The template link for the rule
- template_
uuid str - The UUID of a rule template
- uuid str
- The UUID of the rule
- variables
Sequence[Get
Property Rules Builder Rules V20230105Variable] - A list of variables for a rule
- name String
- The name of a rule
- advanced
Override String - XML metadata of the rule
- behaviors List<Property Map>
- The list of behaviors for a rule
- childrens List<String>
- A list of child rules for a particular rule in JSON format
- comments String
- The comments for a rule
- criteria
Locked Boolean - States whether changes to 'criterion' objects are prohibited
- criteria
Must StringSatisfy - States whether 'all' criteria need to match or 'any'
- criterions List<Property Map>
- The list of criteria for a rule
- custom
Override Property Map - XML metadata of the rule
- is
Secure Boolean - States whether a rule is secure
- template
Link String - The template link for the rule
- template
Uuid String - The UUID of a rule template
- uuid String
- The UUID of the rule
- variables List<Property Map>
- A list of variables for a rule
GetPropertyRulesBuilderRulesV20230105Behavior
- Ad
Scaler GetCircuit Breaker Property Rules Builder Rules V20230105Behavior Ad Scaler Circuit Breaker - This behavior works with
manifestRerouting
to provide the scale and reliability of Akamai network while simultaneously allowing third party partners to modify the requested media content with value-added features. TheadScalerCircuitBreaker
behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object. This behavior cannot be used in includes. - Adaptive
Acceleration GetProperty Rules Builder Rules V20230105Behavior Adaptive Acceleration - Adaptive Acceleration uses HTTP/2 server push functionality with Ion properties to pre-position content and improve the performance of HTML page loading based on real user monitoring (RUM) timing data. It also helps browsers to preconnect to content that’s likely needed for upcoming requests. To use this behavior, make sure you enable the
http2
behavior. Use theAdaptive Acceleration API
to report on the set of assets this feature optimizes. This behavior cannot be used in includes. - Adaptive
Image GetCompression Property Rules Builder Rules V20230105Behavior Adaptive Image Compression Note: Starting from May 31, 2024, Adaptive Image Compression is no longer supported and the image compression configured through this functionality won't take place. As an alternative, we offer
Image & Video Manager
. It intelligently and automatically optimizes images and videos on the fly for every user. Reach out to your Akamai representatives for more information on this product. This behavior can be used in includes.- Advanced
Get
Property Rules Builder Rules V20230105Behavior Advanced - This specifies Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- Aggregated
Reporting GetProperty Rules Builder Rules V20230105Behavior Aggregated Reporting - Configure a custom report that collects traffic data. The data is based on one to four variables, such as
sum
,average
,min
, andmax
. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes. - Akamaizer
Get
Property Rules Builder Rules V20230105Behavior Akamaizer - This allows you to run regular expression substitutions over web pages. To apply this behavior, you need to match on a
contentType
. Contact Akamai Professional Services for help configuring the Akamaizer. See also theakamaizerTag
behavior. This behavior is for internal usage only. This behavior can be used in includes. - Akamaizer
Tag GetProperty Rules Builder Rules V20230105Behavior Akamaizer Tag - This specifies HTML tags and replacement rules for hostnames used in conjunction with the
akamaizer
behavior. Contact Akamai Professional Services for help configuring the Akamaizer. This behavior is for internal usage only. This behavior can be used in includes. - All
Http GetIn Cache Hierarchy Property Rules Builder Rules V20230105Behavior All Http In Cache Hierarchy - Allow all HTTP request methods to be used for the edge's parent servers, useful to implement features such as
Site Shield
,SureRoute
, and Tiered Distribution. (See thesiteShield
,sureRoute
, andtieredDistribution
behaviors.) This behavior can be used in includes. - Allow
Cloudlets GetOrigins Property Rules Builder Rules V20230105Behavior Allow Cloudlets Origins - Allows Cloudlets Origins to determine the criteria, separately from the Property Manager, under which alternate
origin
definitions are assigned. This behavior cannot be used in includes. - Allow
Delete GetProperty Rules Builder Rules V20230105Behavior Allow Delete - Allow HTTP requests using the DELETE method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any DELETE requests pass to the origin. See also the
allowOptions
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - Allow
Https GetCache Key Sharing Property Rules Builder Rules V20230105Behavior Allow Https Cache Key Sharing - HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
- Allow
Https GetDowngrade Property Rules Builder Rules V20230105Behavior Allow Https Downgrade - Passes HTTPS requests to origin as HTTP. This is useful when incorporating Standard TLS or Akamai's shared certificate delivery security with an origin that serves HTTP traffic. This behavior can be used in includes.
- Allow
Options GetProperty Rules Builder Rules V20230105Behavior Allow Options - GET, HEAD, and OPTIONS requests are allowed by default. All other HTTP methods result in a 501 error. For full support of Cross-Origin Resource Sharing (CORS), you need to allow requests that use the OPTIONS method. If you're using the
corsSupport
behavior, do not disable OPTIONS requests. The response to an OPTIONS request is not cached, so the request always goes through the Akamai network to your origin, unless you use theconstructResponse
behavior to send responses directly from the Akamai network. See also theallowDelete
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - Allow
Patch GetProperty Rules Builder Rules V20230105Behavior Allow Patch - Allow HTTP requests using the PATCH method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PATCH requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - Allow
Post GetProperty Rules Builder Rules V20230105Behavior Allow Post - Allow HTTP requests using the POST method. By default, GET, HEAD, and OPTIONS requests are allowed, and POST requests are denied with 403 error. All other methods result in a 501 error. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPut
behaviors. This behavior can be used in includes. - Allow
Put GetProperty Rules Builder Rules V20230105Behavior Allow Put - Allow HTTP requests using the PUT method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PUT requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPost
behaviors. This behavior can be used in includes. - Allow
Transfer GetEncoding Property Rules Builder Rules V20230105Behavior Allow Transfer Encoding - Controls whether to allow or deny Chunked Transfer Encoding (CTE) requests to pass to your origin. If your origin supports CTE, you should enable this behavior. This behavior also protects against a known issue when pairing
http2
andwebdav
behaviors within the same rule tree, in which case it's required. This behavior can be used in includes. - Alt
Svc GetHeader Property Rules Builder Rules V20230105Behavior Alt Svc Header - Sets the maximum age value for the Alternative Services (
Alt-Svc
) header. This behavior can be used in includes. - Api
Prioritization GetProperty Rules Builder Rules V20230105Behavior Api Prioritization - Enables the API Prioritization Cloudlet, which maintains continuity in user experience by serving an alternate static response when load is too high. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. Use this feature serve static API content, such as fallback JSON data. To serve non-API HTML content, use thevisitorPrioritization
behavior. This behavior can be used in includes. - Application
Load GetBalancer Property Rules Builder Rules V20230105Behavior Application Load Balancer - Enables the Application Load Balancer Cloudlet, which automates load balancing based on configurable criteria. To configure this behavior, use either the Cloudlets Policy Manager or the
Cloudlets API
to set up a policy. This behavior cannot be used in includes. - Audience
Segmentation GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation - Allows you to divide your users into different segments based on a persistent cookie. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. This behavior cannot be used in includes. - Auto
Domain GetValidation Property Rules Builder Rules V20230105Behavior Auto Domain Validation - This behavior allows standard TLS domain validated certificates to renew automatically. Apply it after using the
Certificate Provisioning System
to request a certificate for a hostname. To provision certificates programmatically, see theCertificate Provisioning System API
. This behavior can be used in includes. - Base
Directory GetProperty Rules Builder Rules V20230105Behavior Base Directory - Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
- Boss
Beaconing GetProperty Rules Builder Rules V20230105Behavior Boss Beaconing - Triggers diagnostic data beacons for use with BOSS, Akamai's monitoring and diagnostics system. This behavior is for internal usage only. This behavior can be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Breadcrumbs - Provides per-HTTP transaction visibility into a request for content, regardless of how deep the request goes into the Akamai platform. The
Akamai-Request-BC
response header includes various data, such as network health and the location in the Akamai network used to serve content, which simplifies log review for troubleshooting. This behavior can be used in includes. - Break
Connection GetProperty Rules Builder Rules V20230105Behavior Break Connection - This behavior simulates an origin connection problem, typically to test an accompanying
failAction
policy. This behavior can be used in includes. - Brotli
Get
Property Rules Builder Rules V20230105Behavior Brotli - Accesses Brotli-compressed assets from your origin and caches them on edge servers. This doesn't compress resources within the content delivery network in real time. You need to set up Brotli compression separately on your origin. If a requesting client doesn't support Brotli, edge servers deliver non-Brotli resources. This behavior can be used in includes.
- Cache
Error GetProperty Rules Builder Rules V20230105Behavior Cache Error - Caches the origin's error responses to decrease server load. Applies for 10 seconds by default to the following HTTP codes:
204
,305
,404
,405
,501
,502
,503
,504
, and505
. This behavior can be used in includes. - Cache
Id GetProperty Rules Builder Rules V20230105Behavior Cache Id - Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
- Cache
Key GetIgnore Case Property Rules Builder Rules V20230105Behavior Cache Key Ignore Case - By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that
File.html
andfile.html
use separate cache keys. Enabling this behavior forces URL components whose case varies to resolve to the same cache key. Enable this behavior if your origin server is already case-insensitive, such as those based on Microsoft IIS. This behavior can be used in includes. - Cache
Key GetQuery Params Property Rules Builder Rules V20230105Behavior Cache Key Query Params - By default, cache keys are formed as URLs with full query strings. This behavior allows you to consolidate cached objects based on specified sets of query parameters. This behavior can be used in includes.
- Cache
Key GetRewrite Property Rules Builder Rules V20230105Behavior Cache Key Rewrite - This behavior rewrites a default cache key's path. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- Cache
Post GetProperty Rules Builder Rules V20230105Behavior Cache Post - By default, POST requests are passed to the origin. This behavior overrides the default, and allows you to cache POST responses. This behavior can be used in includes.
- Cache
Redirect GetProperty Rules Builder Rules V20230105Behavior Cache Redirect - Controls the caching of HTTP 302 and 307 temporary redirects. By default, Akamai edge servers don't cache them. Enabling this behavior instructs edge servers to allow these redirects to be cached the same as HTTP 200 responses. This behavior can be used in includes.
- Cache
Tag GetProperty Rules Builder Rules V20230105Behavior Cache Tag - This adds a cache tag to the requested object. With cache tags, you can flexibly fast purge tagged segments of your cached content. You can either define these tags with an
Edge-Cache-Tag
header at the origin server level, or use this behavior to directly add a cache tag to the object as the edge server caches it. ThecacheTag
behavior can only take a single value, including a variable. If you want to specify more tags for an object, add a few instances of this behavior to your configuration. This behavior can be used in includes. - Cache
Tag GetVisible Property Rules Builder Rules V20230105Behavior Cache Tag Visible - Cache tags are comma-separated string values you define within an
Edge-Cache-Tag
header. You can use them to flexibly fast purge tagged segments of your cached content. You can either define these headers at the origin server level, or use themodifyOutgoingResponseHeader
behavior to configure them at the edge. Apply this behavior to confirm you're deploying the intended set of cache tags to your content. This behavior can be used in includes. - Caching
Get
Property Rules Builder Rules V20230105Behavior Caching - Control content caching on edge servers: whether or not to cache, whether to honor the origin's caching headers, and for how long to cache. Note that any
NO_STORE
orBYPASS_CACHE
HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see theLearn about caching
section in the guide. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Central Authorization - Forward client requests to the origin server for authorization, along with optional
Set-Cookie
headers, useful when you need to maintain tight access control. The edge server forwards anIf-Modified-Since
header, to which the origin needs to respond with a304
(Not-Modified) HTTP status when authorization succeeds. If so, the edge server responds to the client with the cached object, since it does not need to be re-acquired from the origin. This behavior can be used in includes. - Chase
Redirects GetProperty Rules Builder Rules V20230105Behavior Chase Redirects - Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
- Client
Characteristics GetProperty Rules Builder Rules V20230105Behavior Client Characteristics - Specifies characteristics of the client ecosystem. Akamai uses this information to optimize your metadata configuration, which may result in better end-user performance. This behavior can be used in includes.
- Cloud
Interconnects GetProperty Rules Builder Rules V20230105Behavior Cloud Interconnects - Cloud Interconnects forwards traffic from edge servers to your cloud origin through Private Network Interconnects (PNIs), helping to reduce the egress costs at the origin. Supports origins hosted by Google Cloud Provider (GCP). This behavior cannot be used in includes.
- Cloud
Wrapper GetProperty Rules Builder Rules V20230105Behavior Cloud Wrapper Cloud Wrapper
maximizes origin offload for large libraries of video, game, and software downloads by optimizing data caches in regions nearest to your origin. You can't use this behavior in conjunction withsureRoute
ortieredDistribution
. This behavior cannot be used in includes.- Cloud
Wrapper GetAdvanced Property Rules Builder Rules V20230105Behavior Cloud Wrapper Advanced - Your account representative uses this behavior to implement a customized failover configuration on your behalf. Use Cloud Wrapper Advanced with an enabled
cloudWrapper
behavior in the same rule. This behavior is for internal usage only. This behavior cannot be used in includes. - Conditional
Origin GetProperty Rules Builder Rules V20230105Behavior Conditional Origin - This behavior cannot be used in includes.
- Construct
Response GetProperty Rules Builder Rules V20230105Behavior Construct Response - This behavior constructs an HTTP response, complete with HTTP status code and body, to serve from the edge independently of your origin. For example, you might want to send a customized response if the URL doesn't point to an object on the origin server, or if the end user is not authorized to view the requested content. You can use it with all request methods you allow for your property, including POST. For more details, see the
allowOptions
,allowPatch
,allowPost
,allowPut
, andallowDelete
behaviors. This behavior can be used in includes. - Content
Characteristics GetProperty Rules Builder Rules V20230105Behavior Content Characteristics - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetAmd Property Rules Builder Rules V20230105Behavior Content Characteristics Amd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetDd Property Rules Builder Rules V20230105Behavior Content Characteristics Dd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetWsd Large File Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Large File - Specifies characteristics of the delivered content, specifically targeted to delivering large files. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetWsd Live Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Live - Specifies characteristics of the delivered content, specifically targeted to delivering live video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetWsd Vod Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Vod - Specifies characteristics of the delivered content, specifically targeted to delivering on-demand video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Pre GetPosition Property Rules Builder Rules V20230105Behavior Content Pre Position - Content Preposition. This behavior can be used in includes.
- Content
Targeting GetProtection Property Rules Builder Rules V20230105Behavior Content Targeting Protection - Content Targeting is based on
EdgeScape
, Akamai's location-based access control system. You can use it to allow or deny access to a set of geographic regions or IP addresses. This behavior can be used in includes. - Cors
Support GetProperty Rules Builder Rules V20230105Behavior Cors Support - Cross-origin resource sharing (CORS) allows web pages in one domain to access restricted resources from your domain. Specify external origin hostnames, methods, and headers that you want to accept via HTTP response headers. Full support of CORS requires allowing requests that use the OPTIONS method. See
allowOptions
. This behavior can be used in includes. - Cp
Code GetProperty Rules Builder Rules V20230105Behavior Cp Code - Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. You receive an initial CP code when purchasing Akamai, and you can run the
Create a new CP code
operation to generate more. This behavior applies any valid CP code, either as required as a default at the top of the rule tree, or subsequently to override the default. For a CP code to be valid, it needs to be assigned the same contract and product as the property, and the group needs access to it. For available values, run theList CP codes
operation. This behavior can be used in includes. - Custom
Behavior GetProperty Rules Builder Rules V20230105Behavior Custom Behavior - Allows you to insert a customized XML metadata behavior into any property's rule tree. Talk to your Akamai representative to implement the customized behavior. Once it's ready, run PAPI's
List custom behaviors
operation, then apply the relevantbehaviorId
value from the response within the currentcustomBehavior
. SeeCustom behaviors and overrides
for guidance on custom metadata behaviors. This behavior can be used in includes. - Datastream
Get
Property Rules Builder Rules V20230105Behavior Datastream - The
DataStream
reporting service provides real-time logs on application activity, including aggregated metrics on complete request and response cycles and origin response times. Apply this behavior to report on this set of traffic. Use theDataStream API
to aggregate the data. This behavior cannot be used in includes. - Dcp
Get
Property Rules Builder Rules V20230105Behavior Dcp - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (TheIoT Edge Connect API
allows programmatic access.) This behavior allows you to select previously reserved namespaces and set the protocols for users to publish and receive messages within these namespaces. Use theverifyJsonWebTokenForDcp
behavior to control access. This behavior cannot be used in includes. - Dcp
Auth GetHmac Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Hmac Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then generates a hash value based on the selected algorithm, for use in authenticating the client request. This behavior cannot be used in includes. - Dcp
Auth GetRegex Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Regex Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then transforms the string based on a regular expression search pattern, for use in authenticating the client request. This behavior cannot be used in includes. - Dcp
Auth GetSubstring Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Substring Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then extracts a substring, for use in authenticating the client request. This behavior cannot be used in includes. - Dcp
Auth GetVariable Extractor Property Rules Builder Rules V20230105Behavior Dcp Auth Variable Extractor - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. When enabled, this behavior allows end users to authenticate their requests with valid x509 client certificates. Either a client identifier or access authorization groups are required to make the request valid. This behavior cannot be used in includes. - Dcp
Default GetAuthz Groups Property Rules Builder Rules V20230105Behavior Dcp Default Authz Groups - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior defines a set of default authorization groups to add to each request the property configuration controls. These groups have access regardless of the authentication method you use, either JWT using theverifyJsonWebTokenForDcp
behavior, or mutual authentication using thedcpAuthVariableExtractor
behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes. - Dcp
Dev GetRelations Property Rules Builder Rules V20230105Behavior Dcp Dev Relations - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior allows Akamai-external clients to use developer test accounts in a shared environment. In conjunction withverifyJsonWebTokenForDcp
, this behavior allows you to use your own JWTs in your requests, or those generated by Akamai. It lets you either enable the default JWT server for your test configuration by setting the authentication endpoint to a default path, or specify custom settings for your JWT server and the authentication endpoint. This behavior cannot be used in includes. - Dcp
Real GetTime Auth Property Rules Builder Rules V20230105Behavior Dcp Real Time Auth - INTERNAL ONLY: The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior lets you configure the real time authentication to edge servers. This behavior is for internal usage only. This behavior cannot be used in includes. - Delivery
Receipt GetProperty Rules Builder Rules V20230105Behavior Delivery Receipt - A static behavior that's required when specifying the Cloud Monitor module's (
edgeConnect
behavior. You can only apply this behavior if the property is marked as secure. SeeSecure property requirements
for guidance. This behavior can be used in includes. - Deny
Access GetProperty Rules Builder Rules V20230105Behavior Deny Access - Assuming a condition in the rule matches, this denies access to the requested content. For example, a
userLocation
match paired with this behavior would deny requests from a specified part of the world. This behavior can be used in includes. - Deny
Direct GetFailover Access Property Rules Builder Rules V20230105Behavior Deny Direct Failover Access - A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- Device
Characteristic GetCache Id Property Rules Builder Rules V20230105Behavior Device Characteristic Cache Id - By default, source URLs serve as cache IDs on edge servers. Electronic Data Capture allows you to specify an additional set of device characteristics to generate separate cache keys. Use this in conjunction with the
deviceCharacteristicHeader
behavior. This behavior can be used in includes. - Device
Characteristic GetHeader Property Rules Builder Rules V20230105Behavior Device Characteristic Header - Sends selected information about requesting devices to the origin server, in the form of an
X-Akamai-Device-Characteristics
HTTP header. Use in conjunction with thedeviceCharacteristicCacheId
behavior. This behavior can be used in includes. - Dns
Async GetRefresh Property Rules Builder Rules V20230105Behavior Dns Async Refresh - Allow an edge server to use an expired DNS record when forwarding a request to your origin. The
type A
DNS record refreshesafter
content is served to the end user, so there is no wait for the DNS resolution. Avoid this behavior if you want to be able to disable a server immediately after its DNS record expires. This behavior can be used in includes. - Dns
Prefresh GetProperty Rules Builder Rules V20230105Behavior Dns Prefresh - Allows edge servers to refresh your origin's DNS record independently from end-user requests. The
type A
DNS record refreshes before the origin's DNS record expires. This behavior is for internal usage only. This behavior can be used in includes. - Downgrade
Protocol GetProperty Rules Builder Rules V20230105Behavior Downgrade Protocol - Serve static objects to the end-user client over HTTPS, but fetch them from the origin via HTTP. This behavior cannot be used in includes.
- Download
Complete GetMarker Property Rules Builder Rules V20230105Behavior Download Complete Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes. - Download
Notification GetProperty Rules Builder Rules V20230105Behavior Download Notification - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior allows requests to theOTA Updates API
for a list of completed downloads to individual vehicles. This behavior cannot be used in includes. - Downstream
Cache GetProperty Rules Builder Rules V20230105Behavior Downstream Cache - Specify the caching instructions the edge server sends to the end user's client or client proxies. By default, the cache's duration is whichever is less: the remaining lifetime of the edge cache, or what the origin's header specifies. If the origin is set to
no-store
orbypass-cache
, edge servers sendcache-busting
headers downstream to prevent downstream caching. This behavior can be used in includes. - Dynamic
Throughtput GetOptimization Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization - Enables
quick retry
, which detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. By default, connections under 5 mbps trigger this behavior. When the transfer rate drops below this rate during a connection attempt, quick retry is enabled and a different forward connection path is used. Contact Akamai Professional Services to override this threshold. This behavior can be used in includes. - Dynamic
Throughtput GetOptimization Override Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization Override - This overrides the default threshold of 5 Mbps that triggers the
dynamicThroughtputOptimization
behavior, which enables the quick retry feature. Quick retry detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. This behavior is for internal usage only. This behavior can be used in includes. - Dynamic
Web GetContent Property Rules Builder Rules V20230105Behavior Dynamic Web Content - In conjunction with the
subCustomer
behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers usingAkamai Cloud Embed
. This behavior can be used in includes. - Ecms
Bulk GetUpload Property Rules Builder Rules V20230105Behavior Ecms Bulk Upload - Uploads a ZIP archive with objects to an existing data set. The target data set stores objects as key-value pairs. The path to an object in the ZIP archive is a key, and the content of an object is a value. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - Ecms
Database GetProperty Rules Builder Rules V20230105Behavior Ecms Database - Edge Connect Message Store is available for
Internet of Things: Edge Connect
users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB.ecmsDatabase
specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure theecmsDataset
behavior to specify a default data set for requests. This behavior cannot be used in includes. - Ecms
Dataset GetProperty Rules Builder Rules V20230105Behavior Ecms Dataset - Specifies a default data set for requests to this property unless indicated otherwise in the URL. To access objects in this data set, you can skip the data set name in the URLs. To access objects in a different data set within a database, pass the data set name in the header, query parameter, or a regular expression pattern matching a URL segment. You can also configure the
ecmsDatabase
behavior to specify a default database for requests. This behavior cannot be used in includes. - Ecms
Object GetKey Property Rules Builder Rules V20230105Behavior Ecms Object Key - Defines a regular expression to match object keys in custom URLs and to access objects in a data set. You can point custom URLs to access proper values in the target data set. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - Edge
Connect GetProperty Rules Builder Rules V20230105Behavior Edge Connect - Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
- Edge
Load GetBalancing Advanced Property Rules Builder Rules V20230105Behavior Edge Load Balancing Advanced - This behavior implements customized Edge Load Balancing features. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior cannot be used in includes.
- Edge
Load GetBalancing Data Center Property Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center - The Edge Load Balancing module allows you to specify groups of data centers that implement load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- Edge
Load GetBalancing Origin Property Rules Builder Rules V20230105Behavior Edge Load Balancing Origin - The Edge Load Balancing module allows you to implement groups of data centers featuring load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Edge Origin Authorization - Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
- Edge
Redirector GetProperty Rules Builder Rules V20230105Behavior Edge Redirector - This behavior enables the
Edge Redirector Cloudlet
application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control the Edge Redirector withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - Edge
Scape GetProperty Rules Builder Rules V20230105Behavior Edge Scape EdgeScape
allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a specialX-Akamai-Edgescape
header to the origin server encoding relevant details about the end-user client as key-value pairs. This behavior can be used in includes.- Edge
Side GetIncludes Property Rules Builder Rules V20230105Behavior Edge Side Includes - Allows edge servers to process edge side include (ESI) code to generate dynamic content. To apply this behavior, you need to match on a
contentType
,path
, orfilename
. Since this behavior requires more parsing time, you should not apply it to pages that lack ESI code, or to any non-HTML content. This behavior can be used in includes. - Edge
Worker GetProperty Rules Builder Rules V20230105Behavior Edge Worker EdgeWorkers
are JavaScript applications that allow you to manipulate your web traffic on edge servers outside of Property Manager behaviors, and deployed independently from your configuration's logic. This behavior applies an EdgeWorker to a set of edge requests. This behavior cannot be used in includes.- Enhanced
Akamai GetProtocol Property Rules Builder Rules V20230105Behavior Enhanced Akamai Protocol - Enables the Enhanced Akamai Protocol, a suite of advanced routing and transport optimizations that increase your website's performance and reliability. It is only available to specific applications, and requires a special routing from edge to origin. This behavior can be used in includes.
- Enhanced
Proxy GetDetection Property Rules Builder Rules V20230105Behavior Enhanced Proxy Detection - Enhanced Proxy Detection (EPD) leverages the GeoGuard service provided by GeoComply to add proxy detection and location spoofing protection. It identifies requests for your content that have been redirected from an unwanted source through a proxy. You can then allow, deny, or redirect these requests. This behavior can be used in includes.
- Epd
Forward GetHeader Enrichment Property Rules Builder Rules V20230105Behavior Epd Forward Header Enrichment - This behavior identifies unwanted requests from an anonymous proxy. This and the
enhancedProxyDetection
behavior work together and need to be included either in the same rule, or in the default one. This behavior can be used in includes. - Fail
Action GetProperty Rules Builder Rules V20230105Behavior Fail Action - Specifies how to respond when the origin is not available: by serving stale content, by serving an error page, or by redirecting. To apply this behavior, you should match on an
originTimeout
ormatchResponseCode
. This behavior can be used in includes. - Failover
Bot GetManager Feature Compatibility Property Rules Builder Rules V20230105Behavior Failover Bot Manager Feature Compatibility - Ensures that functionality such as challenge authentication and reset protocol work with a failover product property you use to create an alternate hostname. Apply it to any properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- Fast
Invalidate GetProperty Rules Builder Rules V20230105Behavior Fast Invalidate - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- First
Party GetMarketing Property Rules Builder Rules V20230105Behavior First Party Marketing - Enables the Cloud Marketing Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketingPlus
behavior, which integrates better with both MediaMath and its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - First
Party GetMarketing Plus Property Rules Builder Rules V20230105Behavior First Party Marketing Plus - Enables the Cloud Marketing Plus Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketing
behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - Forward
Rewrite GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite - The Forward Rewrite Cloudlet allows you to conditionally modify the forward path in edge content without affecting the URL that displays in the user's address bar. If Cloudlets are available on your contract, choose
Your services
>Edge logic Cloudlets
to control how this feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - Front
End GetOptimization Property Rules Builder Rules V20230105Behavior Front End Optimization - This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
- G2oheader
Get
Property Rules Builder Rules V20230105Behavior G2oheader - The
signature header authentication
(g2o) security feature provides header-based verification of outgoing origin requests. Edge servers encrypt request data in a pre-defined header, which the origin uses to verify that the edge server processed the request. This behavior configures the request data, header names, encryption algorithm, and shared secret to use for verification. This behavior can be used in includes. - Global
Request GetNumber Property Rules Builder Rules V20230105Behavior Global Request Number - Generates a unique identifier for each request on the Akamai edge network, for use in logging and debugging. GRN identifiers follow the same format as Akamai's error reference strings, for example:
0.05313217.1567801841.1457a3
. You can use the Edge Diagnostics API'sTranslate error string
operation to get low-level details about any request. This behavior can be used in includes. - Graphql
Caching GetProperty Rules Builder Rules V20230105Behavior Graphql Caching - This behavior configures how to cache GraphQL-based API traffic. Enable
caching
for your GraphQL API traffic, along withallowPost
to cache POST responses. To configure REST API traffic, use therapid
behavior. This behavior can be used in includes. - Gzip
Response GetProperty Rules Builder Rules V20230105Behavior Gzip Response - Apply
gzip
compression to speed transfer time. This behavior applies best to text-based content such as HTML, CSS, and JavaScript, especially once files exceed about 10KB. Do not apply it to already compressed image formats, or to small files that would add more time to uncompress. To apply this behavior, you should match oncontentType
or the content'scacheability
. This behavior can be used in includes. - Hd
Data GetAdvanced Property Rules Builder Rules V20230105Behavior Hd Data Advanced - This behavior specifies Akamai XML metadata that can only be configured on your behalf by Akamai Professional Services. Unlike the
advanced
behavior, this may apply a different set of overriding metadata that executes in a post-processing phase. This behavior is for internal usage only. This behavior can be used in includes. - Health
Detection GetProperty Rules Builder Rules V20230105Behavior Health Detection - Monitors the health of your origin server by tracking unsuccessful attempts to contact it. Use this behavior to keep end users from having to wait several seconds before a forwarded request times out, or to reduce requests on the origin server when it is unavailable. This behavior can be used in includes.
- Hsaf
Eip GetBinding Property Rules Builder Rules V20230105Behavior Hsaf Eip Binding - Edge IP Binding works with a limited set of static IP addresses to distribute your content, which can be limiting in large footprint environments. This behavior sets Hash Serial and Forward (HSAF) for Edge IP Binding to deal with larger footprints. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- Http2
Get
Property Rules Builder Rules V20230105Behavior Http2 - Enables the HTTP/2 protocol, which reduces latency and improves efficiency. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
for guidance. This behavior cannot be used in includes. - Http3
Get
Property Rules Builder Rules V20230105Behavior Http3 - This enables the HTTP/3 protocol that uses QUIC. The behavior allows for improved performance and faster connection setup. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
and theProperty Manager documentation
for guidance. This behavior cannot be used in includes. - Http
Strict GetTransport Security Property Rules Builder Rules V20230105Behavior Http Strict Transport Security - Applies HTTP Strict Transport Security (HSTS), disallowing insecure HTTP traffic. Apply this to hostnames managed with Standard TLS or Enhanced TLS certificates. This behavior cannot be used in includes.
- Http
To GetHttps Upgrade Property Rules Builder Rules V20230105Behavior Http To Https Upgrade - Upgrades an HTTP edge request to HTTPS for the remainder of the request flow. Enable this behavior only if your origin supports HTTPS, and if your
origin
behavior is configured withoriginCertsToHonor
to verify SSL certificates. This behavior can be used in includes. - Im
Override GetProperty Rules Builder Rules V20230105Behavior Im Override - This specifies common query parameters that affect how
imageManager
transforms images, potentially overriding policy, width, format, or density request parameters. This also allows you to assign the value of one of the property'srule tree variables
to one of Image and Video Manager's own policy variables. This behavior can be used in includes. - Image
And GetVideo Manager Property Rules Builder Rules V20230105Behavior Image And Video Manager - This behavior can be used in includes.
- Image
Manager GetProperty Rules Builder Rules V20230105Behavior Image Manager - Optimizes images' size or file type for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching images using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. Once you apply Image and Video Manager to traffic, you can add theadvancedImMatch
to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes. - Image
Manager GetVideo Property Rules Builder Rules V20230105Behavior Image Manager Video - Optimizes videos managed by Image and Video Manager for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching videos using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. This behavior can be used in includes. - Include
Get
Property Rules Builder Rules V20230105Behavior Include - Includes let you reuse chunks of a property configuration that you can manage separately from the rest of the property rule tree. This behavior cannot be used in includes.
- Input
Validation GetProperty Rules Builder Rules V20230105Behavior Input Validation - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- Instant
Get
Property Rules Builder Rules V20230105Behavior Instant - The Instant feature allows you to prefetch content to the edge cache by adding link relation attributes to markup. For example: This behavior can be used in includes.
- Instant
Config GetProperty Rules Builder Rules V20230105Behavior Instant Config - Multi-Domain Configuration, also known as
InstantConfig
, allows you to apply property settings to all incoming hostnames based on a DNS lookup, without explicitly listing them among the property's hostnames. This behavior cannot be used in includes. - Large
File GetOptimization Property Rules Builder Rules V20230105Behavior Large File Optimization - The
Large File Optimization
(LFO) feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and you should apply it to anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files, and enable theuseVersioning
option while enforcing your own filename versioning policy. Make sure you meet all therequirements and best practices
for the LFO delivery. This behavior can be used in includes. - Large
File GetOptimization Advanced Property Rules Builder Rules V20230105Behavior Large File Optimization Advanced - The
Large File Optimization
feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and it's recommended for anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files. Note that it is best to useNetStorage
for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes. - Limit
Bit GetRate Property Rules Builder Rules V20230105Behavior Limit Bit Rate - Control the rate at which content serves out to end users, optionally varying the speed depending on the file size or elapsed download time. Each bit rate specified in the
bitrateTable
array corresponds to athresholdTable
entry that activates it. You can use this behavior to prevent media downloads from progressing faster than they are viewed, for example, or to differentiate various tiers of end-user experience. To apply this behavior, you should match on acontentType
,path
, orfilename
. This behavior can be used in includes. - Log
Custom GetProperty Rules Builder Rules V20230105Behavior Log Custom - Logs custom details from the origin response in the
Log Delivery Service
report. This behavior can be used in includes. - MPulse
Get
Property Rules Builder Rules V20230105Behavior MPulse mPulse
provides high-level performance analytics and predictive recommendations based on real end user data. See themPulse Quick Start
to set up mPulse on your website. This behavior cannot be used in includes.- Manifest
Personalization GetProperty Rules Builder Rules V20230105Behavior Manifest Personalization - Allows customers who use the Adaptive Media Delivery product to enhance content based on the capabilities of each end user's device. This behavior configures a
manifest
for both HLS Live and on-demand streaming. For more information, seeAdaptive Media Delivery
. This behavior can be used in includes. - Manifest
Rerouting GetProperty Rules Builder Rules V20230105Behavior Manifest Rerouting - This behavior works with
adScalerCircuitBreaker
. It delegates parts of the media delivery workflow, like ad insertion, to other technology partners. Akamai reroutes manifest file requests to partner platforms for processing prior to being delivered. Rerouting simplifies the workflow and improves the media streaming experience. This behavior cannot be used in includes. - Manual
Server GetPush Property Rules Builder Rules V20230105Behavior Manual Server Push - With the
http2
behavior enabled, this loads a specified set of objects into the client browser's cache. To apply this behavior, you should match on apath
orfilename
. This behavior cannot be used in includes. - Media
Acceleration GetProperty Rules Builder Rules V20230105Behavior Media Acceleration - Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
- Media
Acceleration GetQuic Optout Property Rules Builder Rules V20230105Behavior Media Acceleration Quic Optout - When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
- Media
Client GetProperty Rules Builder Rules V20230105Behavior Media Client - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- Media
File GetRetrieval Optimization Property Rules Builder Rules V20230105Behavior Media File Retrieval Optimization - Media File Retrieval Optimization (MFRO) speeds the delivery of large media files by relying on caches of partial objects. You should use it for files larger than 100 MB. It's required for files larger than 1.8 GB, and works best with
NetStorage
. To apply this behavior, you should match on afileExtension
. This behavior can be used in includes. - Media
Origin GetFailover Property Rules Builder Rules V20230105Behavior Media Origin Failover - Specifies how edge servers respond when the origin is unresponsive, or suffers from server or content errors. You can specify how many times to retry, switch to a backup origin hostname, or configure a redirect. This behavior can be used in includes.
- Metadata
Caching GetProperty Rules Builder Rules V20230105Behavior Metadata Caching - This behavior reduces time spent waiting for the initial response, also known as time to first byte, during peak traffic events. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- Mobile
Sdk GetPerformance Property Rules Builder Rules V20230105Behavior Mobile Sdk Performance - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- Modify
Incoming GetRequest Header Property Rules Builder Rules V20230105Behavior Modify Incoming Request Header - Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
- Modify
Incoming GetResponse Header Property Rules Builder Rules V20230105Behavior Modify Incoming Response Header - Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
- Modify
Outgoing GetRequest Header Property Rules Builder Rules V20230105Behavior Modify Outgoing Request Header - Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
- Modify
Outgoing GetResponse Header Property Rules Builder Rules V20230105Behavior Modify Outgoing Response Header - Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
- Modify
Via GetHeader Property Rules Builder Rules V20230105Behavior Modify Via Header - Removes or renames the HTTP
Via
headers used to inform the server of proxies through which the request was sent to the origin. This behavior can be used in includes. - Origin
Get
Property Rules Builder Rules V20230105Behavior Origin - Specify the hostname and settings used to contact the origin once service begins. You can use your own origin,
NetStorage
, an Edge Load Balancing origin, or a SaaS dynamic origin. This behavior can be used in includes. - Origin
Characteristics GetProperty Rules Builder Rules V20230105Behavior Origin Characteristics - Specifies characteristics of the origin. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior cannot be used in includes.
- Origin
Characteristics GetWsd Property Rules Builder Rules V20230105Behavior Origin Characteristics Wsd - Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
- Origin
Failure GetRecovery Method Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Method - Origin Failover requires that you set up a separate rule containing origin failure recovery methods. You also need to set up the Origin Failure Recovery Policy behavior in a separate rule with a desired match criteria, and select the desired failover method. You can do this using Property Manager. Learn more about this process in
Adaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryPolicy
member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes. - Origin
Failure GetRecovery Policy Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Policy - Configures how to detect an origin failure, in which case the
originFailureRecoveryMethod
behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process inAdaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryMethod
member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes. - Origin
Ip GetAcl Property Rules Builder Rules V20230105Behavior Origin Ip Acl - Origin IP Access Control List limits the traffic to your origin. It only allows requests from specific edge servers that are configured as part of a supernet defined by CIDR blocks. This behavior can be used in includes.
- Persistent
Client GetConnection Property Rules Builder Rules V20230105Behavior Persistent Client Connection - This behavior activates
persistent connections
between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with thepersistentConnection
behavior, which configures persistent connections for the entire journey from origin to edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - Persistent
Connection GetProperty Rules Builder Rules V20230105Behavior Persistent Connection - This behavior enables more efficient
persistent connections
from origin to edge server to client. Compare with thepersistentClientConnection
behavior, which customizes persistent connections from edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - Personally
Identifiable GetInformation Property Rules Builder Rules V20230105Behavior Personally Identifiable Information - Marks content covered by the current rule as sensitive
personally identifiable information
that needs to be treated as secure and private. That includes anything involving personal information: name, social security number, date and place of birth, mother's maiden name, biometric data, or any other data linked to an individual. If you attempt to save a property with such a rule that also caches or logs sensitive content, the added behavior results in a validation error. This behavior cannot be used in includes. - Phased
Release GetProperty Rules Builder Rules V20230105Behavior Phased Release - The Phased Release Cloudlet provides gradual and granular traffic management to an alternate origin in near real time. Use the
Cloudlets API
or the Cloudlets Policy Manager application withinControl Center
to set up your Cloudlets policies. This behavior cannot be used in includes. - Preconnect
Get
Property Rules Builder Rules V20230105Behavior Preconnect - With the
http2
behavior enabled, this requests a specified set of domains that relate to your property hostname, and keeps the connection open for faster loading of content from those domains. This behavior can be used in includes. - Predictive
Content GetDelivery Property Rules Builder Rules V20230105Behavior Predictive Content Delivery - Improves user experience and reduces the cost of downloads by enabling mobile devices to predictively fetch and cache content from catalogs managed by Akamai servers. You can't use this feature if in the
segmentedMediaOptimization
behavior, the value forbehavior
is set toLIVE
. This behavior can be used in includes. - Predictive
Prefetching GetProperty Rules Builder Rules V20230105Behavior Predictive Prefetching - This behavior potentially reduces the client's page load time by pre-caching objects based on historical data for the page, not just its current set of referenced objects. It also detects second-level dependencies, such as objects retrieved by JavaScript. This behavior can be used in includes.
- Prefetch
Get
Property Rules Builder Rules V20230105Behavior Prefetch - Instructs edge servers to retrieve content linked from requested pages as they load, rather than waiting for separate requests for the linked content. This behavior applies depending on the rule's set of matching conditions. Use in conjunction with the
prefetchable
behavior, which specifies the set of objects to prefetch. This behavior can be used in includes. - Prefetchable
Get
Property Rules Builder Rules V20230105Behavior Prefetchable - Allow matching objects to prefetch into the edge cache as the parent page that links to them loads, rather than waiting for a direct request. This behavior applies depending on the rule's set of matching conditions. Use
prefetch
to enable the overall behavior for parent pages that contain links to the object. To apply this behavior, you need to match on afilename
orfileExtension
. This behavior can be used in includes. - Prefresh
Cache GetProperty Rules Builder Rules V20230105Behavior Prefresh Cache - Refresh cached content before its time-to-live (TTL) expires, to keep end users from having to wait for the origin to provide fresh content. This behavior can be used in includes.
- Quality
Get
Property Rules Builder Rules V20230105Behavior Quality - This behavior can be used in includes.
- Quic
Beta GetProperty Rules Builder Rules V20230105Behavior Quic Beta - For a share of responses, includes an
Alt-Svc
header for compatible clients to initiate subsequent sessions using the QUIC protocol. This behavior cannot be used in includes. - Random
Seek GetProperty Rules Builder Rules V20230105Behavior Random Seek - Optimizes
.flv
and.mp4
files to allow random jump-point navigation. This behavior can be used in includes. - Rapid
Get
Property Rules Builder Rules V20230105Behavior Rapid - The
Akamai API Gateway
allows you to configure API traffic delivered over the Akamai network. Apply this behavior to a set of API assets, then use Akamai'sAPI Endpoints API
to configure how the traffic responds. Use theAPI Keys and Traffic Management API
to control access to your APIs. This behavior cannot be used in includes. - Read
Timeout GetProperty Rules Builder Rules V20230105Behavior Read Timeout - This behavior specifies how long the edge server should wait for a response from the requesting forward server after a connection has already been established. This behavior can be used in includes.
- Real
Time GetReporting Property Rules Builder Rules V20230105Behavior Real Time Reporting - This enables Real-Time Reporting for Akamai
Cloud Embed
customers. The behavior can only be configured on your behalf by Akamai Professional Services. You can access real-time reports data for that base configuration withMedia Delivery Reports API
. This behavior is for internal usage only. This behavior can be used in includes. - Real
User GetMonitoring Property Rules Builder Rules V20230105Behavior Real User Monitoring - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- Redirect
Get
Property Rules Builder Rules V20230105Behavior Redirect - Respond to the client request with a redirect without contacting the origin. Specify the redirect as a path expression starting with a
/
character relative to the current root, or as a fully qualified URL. This behavior relies primarily ondestinationHostname
anddestinationPath
to manipulate the hostname and path independently. This behavior can be used in includes. - Redirectplus
Get
Property Rules Builder Rules V20230105Behavior Redirectplus - Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as
redirect
, but allows you to usevariables
to express the redirectdestination
's component values more concisely. This behavior can be used in includes. - Referer
Checking GetProperty Rules Builder Rules V20230105Behavior Referer Checking - Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
- Remove
Query GetParameter Property Rules Builder Rules V20230105Behavior Remove Query Parameter - Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
- Remove
Vary GetProperty Rules Builder Rules V20230105Behavior Remove Vary - By default, responses that feature a
Vary
header value of anything other thanAccept-Encoding
and a correspondingContent-Encoding: gzip
header aren't cached on edge servers.Vary
headers indicate when a URL's content varies depending on some variable, such as whichUser-Agent
requests it. This behavior simply removes theVary
header to make responses cacheable. This behavior can be used in includes. - Report
Get
Property Rules Builder Rules V20230105Behavior Report - Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
- Request
Control GetProperty Rules Builder Rules V20230105Behavior Request Control - The Request Control Cloudlet allows you to control access to your web content based on the incoming request's IP or geographic location. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control how the feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - Request
Type GetMarker Property Rules Builder Rules V20230105Behavior Request Type Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. When using thedownloadCompleteMarker
behavior to log successful downloads, this related behavior identifies download or campaign server types in aggregated and individual reports. This behavior can be used in includes. - Resource
Optimizer GetProperty Rules Builder Rules V20230105Behavior Resource Optimizer - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- Resource
Optimizer GetExtended Compatibility Property Rules Builder Rules V20230105Behavior Resource Optimizer Extended Compatibility - This enhances the standard version of the
resourceOptimizer
behavior to support the compression of additional file formats and address some compatibility issues. This behavior can be used in includes. - Response
Code GetProperty Rules Builder Rules V20230105Behavior Response Code - Change the existing response code. For example, if your origin sends a
301
permanent redirect, this behavior can change it on the edge to a temporary302
redirect. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Response Cookie - Set a cookie to send downstream to the client with either a fixed value or a unique stamp. This behavior can be used in includes.
- Restrict
Object GetCaching Property Rules Builder Rules V20230105Behavior Restrict Object Caching - You need this behavior to deploy the Object Caching product. It disables serving HTML content and limits the maximum object size to 100MB. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- Return
Cache GetStatus Property Rules Builder Rules V20230105Behavior Return Cache Status - Generates a response header with information about cache status. Among other things, this can tell you whether the response came from the Akamai cache, or from the origin. Status values report with either of these forms of syntax, depending for example on whether you're deploying traffic using
sureRoute
ortieredDistribution
: This behavior can be used in includes. - Rewrite
Url GetProperty Rules Builder Rules V20230105Behavior Rewrite Url - Modifies the path of incoming requests to forward to the origin. This helps you offload URL-rewriting tasks to the edge to increase the origin server's performance, allows you to redirect links to different targets without changing markup, and hides your original directory structure. This behavior can be used in includes.
- Rum
Custom GetProperty Rules Builder Rules V20230105Behavior Rum Custom - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- Saas
Definitions GetProperty Rules Builder Rules V20230105Behavior Saas Definitions - Configures how the Software as a Service feature identifies
customers
,applications
, andusers
. A different set of options is available for each type of targeted request, each enabled with theaction
-suffixed option. In each case, you can usePATH
,COOKIE
,QUERY_STRING
, orHOSTNAME
components as identifiers, ordisable
the SaaS behavior for certain targets. If you rely on aHOSTNAME
, you also have the option of specifying aCNAME chain
rather than an individual hostname. The various options suffixedregex
andreplace
subsequently remove the identifier from the request. This behavior requires a siblingorigin
behavior whoseoriginType
option is set toSAAS_DYNAMIC_ORIGIN
. This behavior cannot be used in includes. - Sales
Force GetCommerce Cloud Client Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Client - If you use the Salesforce Commerce Cloud platform for your origin content, this behavior allows your edge content managed by Akamai to contact directly to origin. This behavior cannot be used in includes.
- Sales
Force GetCommerce Cloud Provider Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider - This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- Sales
Force GetCommerce Cloud Provider Host Header Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider Host Header - Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- Save
Post GetDca Processing Property Rules Builder Rules V20230105Behavior Save Post Dca Processing - Used in conjunction with the
cachePost
behavior, this behavior allows the body of POST requests to be processed through Dynamic Content Assembly. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes. - Schedule
Invalidation GetProperty Rules Builder Rules V20230105Behavior Schedule Invalidation - Specifies when cached content that satisfies a rule's criteria expires, optionally at repeating intervals. In addition to periodic cache flushes, you can use this behavior to minimize potential conflicts when related objects expire at different times. This behavior can be used in includes.
- Script
Management GetProperty Rules Builder Rules V20230105Behavior Script Management - Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. See
Script Management API
for more information. This behavior cannot be used in includes. - Segmented
Content GetProtection Property Rules Builder Rules V20230105Behavior Segmented Content Protection - Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
- Segmented
Media GetOptimization Property Rules Builder Rules V20230105Behavior Segmented Media Optimization - Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
- Segmented
Media GetStreaming Prefetch Property Rules Builder Rules V20230105Behavior Segmented Media Streaming Prefetch - Prefetches HLS and DASH media stream manifest and segment files, accelerating delivery to end users. For prefetching to work, your origin media's response needs to specify
CDN-Origin-Assist-Prefetch-Path
headers with each URL to prefetch, expressed as either a relative or absolute path. This behavior can be used in includes. - Set
Variable GetProperty Rules Builder Rules V20230105Behavior Set Variable - Modify a variable to insert into subsequent fields within the rule tree. Use this behavior to specify the predeclared
variableName
and determine from where to derive its new value. Based on thisvalueSource
, you can either generate the value, extract it from some part of the incoming request, assign it from another variable (including a set of built-in system variables), or directly specify its text. Optionally choose atransform
function to modify the value once. SeeSupport for variables
for more information. This behavior can be used in includes. - Shutr
Get
Property Rules Builder Rules V20230105Behavior Shutr - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- Simulate
Error GetCode Property Rules Builder Rules V20230105Behavior Simulate Error Code - This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- Site
Shield GetProperty Rules Builder Rules V20230105Behavior Site Shield - This behavior implements the
Site Shield
feature, which helps prevent non-Akamai machines from contacting your origin. You get an email with a list of Akamai servers allowed to contact your origin, with which you establish an Access Control List on your firewall to prevent any other requests. This behavior cannot be used in includes. - Standard
Tls GetMigration Property Rules Builder Rules V20230105Behavior Standard Tls Migration - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- Standard
Tls GetMigration Override Property Rules Builder Rules V20230105Behavior Standard Tls Migration Override - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- Strict
Header GetParsing Property Rules Builder Rules V20230105Behavior Strict Header Parsing - This behavior specifies how the edge servers should handle requests containing improperly formatted or invalid headers that don’t comply with
RFC 9110
. This behavior can be used in includes. - Sub
Customer GetProperty Rules Builder Rules V20230105Behavior Sub Customer - When positioned in a property's top-level default rule, enables various
Cloud Embed
features that allow you to leverage Akamai's CDN architecture for your own subcustomers. This behavior's options allow you to use Cloud Embed to configure your subcustomers' content. Once enabled, you can use theAkamai Cloud Embed API
(ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also thedynamicWebContent
behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes. - Sure
Route GetProperty Rules Builder Rules V20230105Behavior Sure Route - The
SureRoute
feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conductsraces
to identify alternative paths to use in case of a transmission failure. These races increase origin traffic slightly. This behavior cannot be used in includes. - Tcp
Optimization GetProperty Rules Builder Rules V20230105Behavior Tcp Optimization - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- Tea
Leaf GetProperty Rules Builder Rules V20230105Behavior Tea Leaf - Allows IBM Tealeaf Customer Experience on Cloud to record HTTPS requests and responses for Akamai-enabled properties. Recorded data becomes available in your IBM Tealeaf account. This behavior cannot be used in includes.
- Tiered
Distribution GetProperty Rules Builder Rules V20230105Behavior Tiered Distribution - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This behavior cannot be used in includes. - Tiered
Distribution GetAdvanced Property Rules Builder Rules V20230105Behavior Tiered Distribution Advanced - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This advanced behavior provides a wider set of options thantieredDistribution
. This behavior is for internal usage only. This behavior can be used in includes. - Tiered
Distribution GetCustomization Property Rules Builder Rules V20230105Behavior Tiered Distribution Customization - With Tiered Distribution, Akamai edge servers retrieve cached content from other Akamai servers, rather than directly from the origin. This behavior sets custom Tiered Distribution maps (TD0) and migrates TD1 maps configured with
advanced features
to Cloud Wrapper. You need to enablecloudWrapper
within the same rule. This behavior is for internal usage only. This behavior can be used in includes. - Timeout
Get
Property Rules Builder Rules V20230105Behavior Timeout - Sets the HTTP connect timeout. This behavior can be used in includes.
- Uid
Configuration GetProperty Rules Builder Rules V20230105Behavior Uid Configuration - This behavior allows you to extract unique identifier (UID) values from live traffic, for use in OTA applications. Note that you are responsible for maintaining the security of any data that may identify individual users. This behavior cannot be used in includes.
- Validate
Entity GetTag Property Rules Builder Rules V20230105Behavior Validate Entity Tag - Instructs edge servers to compare the request's
ETag
header with that of the cached object. If they differ, the edge server sends a new copy of the object. This validation occurs in addition to the default validation ofLast-Modified
andIf-Modified-Since
headers. This behavior can be used in includes. - Verify
Json GetWeb Token Property Rules Builder Rules V20230105Behavior Verify Json Web Token - This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
- Verify
Json GetWeb Token For Dcp Property Rules Builder Rules V20230105Behavior Verify Json Web Token For Dcp - This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing
IoT Edge Connect
, which you use thedcp
behavior to configure. You can specify the location in a request to pass a JSON web token (JWT), collections of public keys to verify the integrity of this token, and specific claims to extract from it. Use theverifyJsonWebToken
behavior for other JWT validation. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Verify Token Authorization - Verifies Auth 2.0 tokens. This behavior can be used in includes.
- Virtual
Waiting GetRoom Property Rules Builder Rules V20230105Behavior Virtual Waiting Room - This behavior helps you maintain business continuity for dynamic applications in high-demand situations such as flash sales. It decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a request processing mechanism that prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control Virtual Waitig Room withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - Virtual
Waiting GetRoom With Edge Workers Property Rules Builder Rules V20230105Behavior Virtual Waiting Room With Edge Workers - This behavior allows you to configure the
virtualWaitingRoom
behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes. - Visitor
Prioritization GetProperty Rules Builder Rules V20230105Behavior Visitor Prioritization - The
Visitor Prioritization Cloudlet
decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - Visitor
Prioritization GetFifo Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo - (BETA) The
Visitor Prioritization Cloudlet (FIFO)
decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a fair request processing mechanism, which prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization (FIFO) withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - Visitor
Prioritization GetFifo Standalone Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo Standalone - This behavior cannot be used in includes.
- Watermarking
Get
Property Rules Builder Rules V20230105Behavior Watermarking - Adds watermarking for each valid user's content. Content segments are delivered from different sources using a pattern unique to each user, based on a watermarking token included in each request. If your content is pirated or redistributed, you can forensically analyze the segments to extract the pattern, and identify the user who leaked the content. This behavior can be used in includes.
- Web
Application GetFirewall Property Rules Builder Rules V20230105Behavior Web Application Firewall - This behavior implements a suite of security features that blocks threatening HTTP and HTTPS requests. Use it as your primary firewall, or in addition to existing security measures. Only one referenced configuration is allowed per property, so this behavior typically belongs as part of its default rule. This behavior cannot be used in includes.
- Web
Sockets GetProperty Rules Builder Rules V20230105Behavior Web Sockets - The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
- Webdav
Get
Property Rules Builder Rules V20230105Behavior Webdav - Web-based Distributed Authoring and Versioning (WebDAV) is a set of extensions to the HTTP protocol that allows users to collaboratively edit and manage files on remote web servers. This behavior enables WebDAV, and provides support for the following additional request methods: PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. To apply this behavior, you need to match on a
requestMethod
. This behavior can be used in includes.
- Ad
Scaler GetCircuit Breaker Property Rules Builder Rules V20230105Behavior Ad Scaler Circuit Breaker - This behavior works with
manifestRerouting
to provide the scale and reliability of Akamai network while simultaneously allowing third party partners to modify the requested media content with value-added features. TheadScalerCircuitBreaker
behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object. This behavior cannot be used in includes. - Adaptive
Acceleration GetProperty Rules Builder Rules V20230105Behavior Adaptive Acceleration - Adaptive Acceleration uses HTTP/2 server push functionality with Ion properties to pre-position content and improve the performance of HTML page loading based on real user monitoring (RUM) timing data. It also helps browsers to preconnect to content that’s likely needed for upcoming requests. To use this behavior, make sure you enable the
http2
behavior. Use theAdaptive Acceleration API
to report on the set of assets this feature optimizes. This behavior cannot be used in includes. - Adaptive
Image GetCompression Property Rules Builder Rules V20230105Behavior Adaptive Image Compression Note: Starting from May 31, 2024, Adaptive Image Compression is no longer supported and the image compression configured through this functionality won't take place. As an alternative, we offer
Image & Video Manager
. It intelligently and automatically optimizes images and videos on the fly for every user. Reach out to your Akamai representatives for more information on this product. This behavior can be used in includes.- Advanced
Get
Property Rules Builder Rules V20230105Behavior Advanced - This specifies Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- Aggregated
Reporting GetProperty Rules Builder Rules V20230105Behavior Aggregated Reporting - Configure a custom report that collects traffic data. The data is based on one to four variables, such as
sum
,average
,min
, andmax
. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes. - Akamaizer
Get
Property Rules Builder Rules V20230105Behavior Akamaizer - This allows you to run regular expression substitutions over web pages. To apply this behavior, you need to match on a
contentType
. Contact Akamai Professional Services for help configuring the Akamaizer. See also theakamaizerTag
behavior. This behavior is for internal usage only. This behavior can be used in includes. - Akamaizer
Tag GetProperty Rules Builder Rules V20230105Behavior Akamaizer Tag - This specifies HTML tags and replacement rules for hostnames used in conjunction with the
akamaizer
behavior. Contact Akamai Professional Services for help configuring the Akamaizer. This behavior is for internal usage only. This behavior can be used in includes. - All
Http GetIn Cache Hierarchy Property Rules Builder Rules V20230105Behavior All Http In Cache Hierarchy - Allow all HTTP request methods to be used for the edge's parent servers, useful to implement features such as
Site Shield
,SureRoute
, and Tiered Distribution. (See thesiteShield
,sureRoute
, andtieredDistribution
behaviors.) This behavior can be used in includes. - Allow
Cloudlets GetOrigins Property Rules Builder Rules V20230105Behavior Allow Cloudlets Origins - Allows Cloudlets Origins to determine the criteria, separately from the Property Manager, under which alternate
origin
definitions are assigned. This behavior cannot be used in includes. - Allow
Delete GetProperty Rules Builder Rules V20230105Behavior Allow Delete - Allow HTTP requests using the DELETE method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any DELETE requests pass to the origin. See also the
allowOptions
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - Allow
Https GetCache Key Sharing Property Rules Builder Rules V20230105Behavior Allow Https Cache Key Sharing - HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
- Allow
Https GetDowngrade Property Rules Builder Rules V20230105Behavior Allow Https Downgrade - Passes HTTPS requests to origin as HTTP. This is useful when incorporating Standard TLS or Akamai's shared certificate delivery security with an origin that serves HTTP traffic. This behavior can be used in includes.
- Allow
Options GetProperty Rules Builder Rules V20230105Behavior Allow Options - GET, HEAD, and OPTIONS requests are allowed by default. All other HTTP methods result in a 501 error. For full support of Cross-Origin Resource Sharing (CORS), you need to allow requests that use the OPTIONS method. If you're using the
corsSupport
behavior, do not disable OPTIONS requests. The response to an OPTIONS request is not cached, so the request always goes through the Akamai network to your origin, unless you use theconstructResponse
behavior to send responses directly from the Akamai network. See also theallowDelete
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - Allow
Patch GetProperty Rules Builder Rules V20230105Behavior Allow Patch - Allow HTTP requests using the PATCH method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PATCH requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - Allow
Post GetProperty Rules Builder Rules V20230105Behavior Allow Post - Allow HTTP requests using the POST method. By default, GET, HEAD, and OPTIONS requests are allowed, and POST requests are denied with 403 error. All other methods result in a 501 error. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPut
behaviors. This behavior can be used in includes. - Allow
Put GetProperty Rules Builder Rules V20230105Behavior Allow Put - Allow HTTP requests using the PUT method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PUT requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPost
behaviors. This behavior can be used in includes. - Allow
Transfer GetEncoding Property Rules Builder Rules V20230105Behavior Allow Transfer Encoding - Controls whether to allow or deny Chunked Transfer Encoding (CTE) requests to pass to your origin. If your origin supports CTE, you should enable this behavior. This behavior also protects against a known issue when pairing
http2
andwebdav
behaviors within the same rule tree, in which case it's required. This behavior can be used in includes. - Alt
Svc GetHeader Property Rules Builder Rules V20230105Behavior Alt Svc Header - Sets the maximum age value for the Alternative Services (
Alt-Svc
) header. This behavior can be used in includes. - Api
Prioritization GetProperty Rules Builder Rules V20230105Behavior Api Prioritization - Enables the API Prioritization Cloudlet, which maintains continuity in user experience by serving an alternate static response when load is too high. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. Use this feature serve static API content, such as fallback JSON data. To serve non-API HTML content, use thevisitorPrioritization
behavior. This behavior can be used in includes. - Application
Load GetBalancer Property Rules Builder Rules V20230105Behavior Application Load Balancer - Enables the Application Load Balancer Cloudlet, which automates load balancing based on configurable criteria. To configure this behavior, use either the Cloudlets Policy Manager or the
Cloudlets API
to set up a policy. This behavior cannot be used in includes. - Audience
Segmentation GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation - Allows you to divide your users into different segments based on a persistent cookie. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. This behavior cannot be used in includes. - Auto
Domain GetValidation Property Rules Builder Rules V20230105Behavior Auto Domain Validation - This behavior allows standard TLS domain validated certificates to renew automatically. Apply it after using the
Certificate Provisioning System
to request a certificate for a hostname. To provision certificates programmatically, see theCertificate Provisioning System API
. This behavior can be used in includes. - Base
Directory GetProperty Rules Builder Rules V20230105Behavior Base Directory - Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
- Boss
Beaconing GetProperty Rules Builder Rules V20230105Behavior Boss Beaconing - Triggers diagnostic data beacons for use with BOSS, Akamai's monitoring and diagnostics system. This behavior is for internal usage only. This behavior can be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Breadcrumbs - Provides per-HTTP transaction visibility into a request for content, regardless of how deep the request goes into the Akamai platform. The
Akamai-Request-BC
response header includes various data, such as network health and the location in the Akamai network used to serve content, which simplifies log review for troubleshooting. This behavior can be used in includes. - Break
Connection GetProperty Rules Builder Rules V20230105Behavior Break Connection - This behavior simulates an origin connection problem, typically to test an accompanying
failAction
policy. This behavior can be used in includes. - Brotli
Get
Property Rules Builder Rules V20230105Behavior Brotli - Accesses Brotli-compressed assets from your origin and caches them on edge servers. This doesn't compress resources within the content delivery network in real time. You need to set up Brotli compression separately on your origin. If a requesting client doesn't support Brotli, edge servers deliver non-Brotli resources. This behavior can be used in includes.
- Cache
Error GetProperty Rules Builder Rules V20230105Behavior Cache Error - Caches the origin's error responses to decrease server load. Applies for 10 seconds by default to the following HTTP codes:
204
,305
,404
,405
,501
,502
,503
,504
, and505
. This behavior can be used in includes. - Cache
Id GetProperty Rules Builder Rules V20230105Behavior Cache Id - Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
- Cache
Key GetIgnore Case Property Rules Builder Rules V20230105Behavior Cache Key Ignore Case - By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that
File.html
andfile.html
use separate cache keys. Enabling this behavior forces URL components whose case varies to resolve to the same cache key. Enable this behavior if your origin server is already case-insensitive, such as those based on Microsoft IIS. This behavior can be used in includes. - Cache
Key GetQuery Params Property Rules Builder Rules V20230105Behavior Cache Key Query Params - By default, cache keys are formed as URLs with full query strings. This behavior allows you to consolidate cached objects based on specified sets of query parameters. This behavior can be used in includes.
- Cache
Key GetRewrite Property Rules Builder Rules V20230105Behavior Cache Key Rewrite - This behavior rewrites a default cache key's path. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- Cache
Post GetProperty Rules Builder Rules V20230105Behavior Cache Post - By default, POST requests are passed to the origin. This behavior overrides the default, and allows you to cache POST responses. This behavior can be used in includes.
- Cache
Redirect GetProperty Rules Builder Rules V20230105Behavior Cache Redirect - Controls the caching of HTTP 302 and 307 temporary redirects. By default, Akamai edge servers don't cache them. Enabling this behavior instructs edge servers to allow these redirects to be cached the same as HTTP 200 responses. This behavior can be used in includes.
- Cache
Tag GetProperty Rules Builder Rules V20230105Behavior Cache Tag - This adds a cache tag to the requested object. With cache tags, you can flexibly fast purge tagged segments of your cached content. You can either define these tags with an
Edge-Cache-Tag
header at the origin server level, or use this behavior to directly add a cache tag to the object as the edge server caches it. ThecacheTag
behavior can only take a single value, including a variable. If you want to specify more tags for an object, add a few instances of this behavior to your configuration. This behavior can be used in includes. - Cache
Tag GetVisible Property Rules Builder Rules V20230105Behavior Cache Tag Visible - Cache tags are comma-separated string values you define within an
Edge-Cache-Tag
header. You can use them to flexibly fast purge tagged segments of your cached content. You can either define these headers at the origin server level, or use themodifyOutgoingResponseHeader
behavior to configure them at the edge. Apply this behavior to confirm you're deploying the intended set of cache tags to your content. This behavior can be used in includes. - Caching
Get
Property Rules Builder Rules V20230105Behavior Caching - Control content caching on edge servers: whether or not to cache, whether to honor the origin's caching headers, and for how long to cache. Note that any
NO_STORE
orBYPASS_CACHE
HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see theLearn about caching
section in the guide. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Central Authorization - Forward client requests to the origin server for authorization, along with optional
Set-Cookie
headers, useful when you need to maintain tight access control. The edge server forwards anIf-Modified-Since
header, to which the origin needs to respond with a304
(Not-Modified) HTTP status when authorization succeeds. If so, the edge server responds to the client with the cached object, since it does not need to be re-acquired from the origin. This behavior can be used in includes. - Chase
Redirects GetProperty Rules Builder Rules V20230105Behavior Chase Redirects - Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
- Client
Characteristics GetProperty Rules Builder Rules V20230105Behavior Client Characteristics - Specifies characteristics of the client ecosystem. Akamai uses this information to optimize your metadata configuration, which may result in better end-user performance. This behavior can be used in includes.
- Cloud
Interconnects GetProperty Rules Builder Rules V20230105Behavior Cloud Interconnects - Cloud Interconnects forwards traffic from edge servers to your cloud origin through Private Network Interconnects (PNIs), helping to reduce the egress costs at the origin. Supports origins hosted by Google Cloud Provider (GCP). This behavior cannot be used in includes.
- Cloud
Wrapper GetProperty Rules Builder Rules V20230105Behavior Cloud Wrapper Cloud Wrapper
maximizes origin offload for large libraries of video, game, and software downloads by optimizing data caches in regions nearest to your origin. You can't use this behavior in conjunction withsureRoute
ortieredDistribution
. This behavior cannot be used in includes.- Cloud
Wrapper GetAdvanced Property Rules Builder Rules V20230105Behavior Cloud Wrapper Advanced - Your account representative uses this behavior to implement a customized failover configuration on your behalf. Use Cloud Wrapper Advanced with an enabled
cloudWrapper
behavior in the same rule. This behavior is for internal usage only. This behavior cannot be used in includes. - Conditional
Origin GetProperty Rules Builder Rules V20230105Behavior Conditional Origin - This behavior cannot be used in includes.
- Construct
Response GetProperty Rules Builder Rules V20230105Behavior Construct Response - This behavior constructs an HTTP response, complete with HTTP status code and body, to serve from the edge independently of your origin. For example, you might want to send a customized response if the URL doesn't point to an object on the origin server, or if the end user is not authorized to view the requested content. You can use it with all request methods you allow for your property, including POST. For more details, see the
allowOptions
,allowPatch
,allowPost
,allowPut
, andallowDelete
behaviors. This behavior can be used in includes. - Content
Characteristics GetProperty Rules Builder Rules V20230105Behavior Content Characteristics - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetAmd Property Rules Builder Rules V20230105Behavior Content Characteristics Amd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetDd Property Rules Builder Rules V20230105Behavior Content Characteristics Dd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetWsd Large File Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Large File - Specifies characteristics of the delivered content, specifically targeted to delivering large files. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetWsd Live Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Live - Specifies characteristics of the delivered content, specifically targeted to delivering live video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Characteristics GetWsd Vod Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Vod - Specifies characteristics of the delivered content, specifically targeted to delivering on-demand video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- Content
Pre GetPosition Property Rules Builder Rules V20230105Behavior Content Pre Position - Content Preposition. This behavior can be used in includes.
- Content
Targeting GetProtection Property Rules Builder Rules V20230105Behavior Content Targeting Protection - Content Targeting is based on
EdgeScape
, Akamai's location-based access control system. You can use it to allow or deny access to a set of geographic regions or IP addresses. This behavior can be used in includes. - Cors
Support GetProperty Rules Builder Rules V20230105Behavior Cors Support - Cross-origin resource sharing (CORS) allows web pages in one domain to access restricted resources from your domain. Specify external origin hostnames, methods, and headers that you want to accept via HTTP response headers. Full support of CORS requires allowing requests that use the OPTIONS method. See
allowOptions
. This behavior can be used in includes. - Cp
Code GetProperty Rules Builder Rules V20230105Behavior Cp Code - Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. You receive an initial CP code when purchasing Akamai, and you can run the
Create a new CP code
operation to generate more. This behavior applies any valid CP code, either as required as a default at the top of the rule tree, or subsequently to override the default. For a CP code to be valid, it needs to be assigned the same contract and product as the property, and the group needs access to it. For available values, run theList CP codes
operation. This behavior can be used in includes. - Custom
Behavior GetProperty Rules Builder Rules V20230105Behavior Custom Behavior - Allows you to insert a customized XML metadata behavior into any property's rule tree. Talk to your Akamai representative to implement the customized behavior. Once it's ready, run PAPI's
List custom behaviors
operation, then apply the relevantbehaviorId
value from the response within the currentcustomBehavior
. SeeCustom behaviors and overrides
for guidance on custom metadata behaviors. This behavior can be used in includes. - Datastream
Get
Property Rules Builder Rules V20230105Behavior Datastream - The
DataStream
reporting service provides real-time logs on application activity, including aggregated metrics on complete request and response cycles and origin response times. Apply this behavior to report on this set of traffic. Use theDataStream API
to aggregate the data. This behavior cannot be used in includes. - Dcp
Get
Property Rules Builder Rules V20230105Behavior Dcp - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (TheIoT Edge Connect API
allows programmatic access.) This behavior allows you to select previously reserved namespaces and set the protocols for users to publish and receive messages within these namespaces. Use theverifyJsonWebTokenForDcp
behavior to control access. This behavior cannot be used in includes. - Dcp
Auth GetHmac Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Hmac Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then generates a hash value based on the selected algorithm, for use in authenticating the client request. This behavior cannot be used in includes. - Dcp
Auth GetRegex Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Regex Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then transforms the string based on a regular expression search pattern, for use in authenticating the client request. This behavior cannot be used in includes. - Dcp
Auth GetSubstring Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Substring Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then extracts a substring, for use in authenticating the client request. This behavior cannot be used in includes. - Dcp
Auth GetVariable Extractor Property Rules Builder Rules V20230105Behavior Dcp Auth Variable Extractor - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. When enabled, this behavior allows end users to authenticate their requests with valid x509 client certificates. Either a client identifier or access authorization groups are required to make the request valid. This behavior cannot be used in includes. - Dcp
Default GetAuthz Groups Property Rules Builder Rules V20230105Behavior Dcp Default Authz Groups - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior defines a set of default authorization groups to add to each request the property configuration controls. These groups have access regardless of the authentication method you use, either JWT using theverifyJsonWebTokenForDcp
behavior, or mutual authentication using thedcpAuthVariableExtractor
behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes. - Dcp
Dev GetRelations Property Rules Builder Rules V20230105Behavior Dcp Dev Relations - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior allows Akamai-external clients to use developer test accounts in a shared environment. In conjunction withverifyJsonWebTokenForDcp
, this behavior allows you to use your own JWTs in your requests, or those generated by Akamai. It lets you either enable the default JWT server for your test configuration by setting the authentication endpoint to a default path, or specify custom settings for your JWT server and the authentication endpoint. This behavior cannot be used in includes. - Dcp
Real GetTime Auth Property Rules Builder Rules V20230105Behavior Dcp Real Time Auth - INTERNAL ONLY: The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior lets you configure the real time authentication to edge servers. This behavior is for internal usage only. This behavior cannot be used in includes. - Delivery
Receipt GetProperty Rules Builder Rules V20230105Behavior Delivery Receipt - A static behavior that's required when specifying the Cloud Monitor module's (
edgeConnect
behavior. You can only apply this behavior if the property is marked as secure. SeeSecure property requirements
for guidance. This behavior can be used in includes. - Deny
Access GetProperty Rules Builder Rules V20230105Behavior Deny Access - Assuming a condition in the rule matches, this denies access to the requested content. For example, a
userLocation
match paired with this behavior would deny requests from a specified part of the world. This behavior can be used in includes. - Deny
Direct GetFailover Access Property Rules Builder Rules V20230105Behavior Deny Direct Failover Access - A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- Device
Characteristic GetCache Id Property Rules Builder Rules V20230105Behavior Device Characteristic Cache Id - By default, source URLs serve as cache IDs on edge servers. Electronic Data Capture allows you to specify an additional set of device characteristics to generate separate cache keys. Use this in conjunction with the
deviceCharacteristicHeader
behavior. This behavior can be used in includes. - Device
Characteristic GetHeader Property Rules Builder Rules V20230105Behavior Device Characteristic Header - Sends selected information about requesting devices to the origin server, in the form of an
X-Akamai-Device-Characteristics
HTTP header. Use in conjunction with thedeviceCharacteristicCacheId
behavior. This behavior can be used in includes. - Dns
Async GetRefresh Property Rules Builder Rules V20230105Behavior Dns Async Refresh - Allow an edge server to use an expired DNS record when forwarding a request to your origin. The
type A
DNS record refreshesafter
content is served to the end user, so there is no wait for the DNS resolution. Avoid this behavior if you want to be able to disable a server immediately after its DNS record expires. This behavior can be used in includes. - Dns
Prefresh GetProperty Rules Builder Rules V20230105Behavior Dns Prefresh - Allows edge servers to refresh your origin's DNS record independently from end-user requests. The
type A
DNS record refreshes before the origin's DNS record expires. This behavior is for internal usage only. This behavior can be used in includes. - Downgrade
Protocol GetProperty Rules Builder Rules V20230105Behavior Downgrade Protocol - Serve static objects to the end-user client over HTTPS, but fetch them from the origin via HTTP. This behavior cannot be used in includes.
- Download
Complete GetMarker Property Rules Builder Rules V20230105Behavior Download Complete Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes. - Download
Notification GetProperty Rules Builder Rules V20230105Behavior Download Notification - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior allows requests to theOTA Updates API
for a list of completed downloads to individual vehicles. This behavior cannot be used in includes. - Downstream
Cache GetProperty Rules Builder Rules V20230105Behavior Downstream Cache - Specify the caching instructions the edge server sends to the end user's client or client proxies. By default, the cache's duration is whichever is less: the remaining lifetime of the edge cache, or what the origin's header specifies. If the origin is set to
no-store
orbypass-cache
, edge servers sendcache-busting
headers downstream to prevent downstream caching. This behavior can be used in includes. - Dynamic
Throughtput GetOptimization Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization - Enables
quick retry
, which detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. By default, connections under 5 mbps trigger this behavior. When the transfer rate drops below this rate during a connection attempt, quick retry is enabled and a different forward connection path is used. Contact Akamai Professional Services to override this threshold. This behavior can be used in includes. - Dynamic
Throughtput GetOptimization Override Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization Override - This overrides the default threshold of 5 Mbps that triggers the
dynamicThroughtputOptimization
behavior, which enables the quick retry feature. Quick retry detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. This behavior is for internal usage only. This behavior can be used in includes. - Dynamic
Web GetContent Property Rules Builder Rules V20230105Behavior Dynamic Web Content - In conjunction with the
subCustomer
behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers usingAkamai Cloud Embed
. This behavior can be used in includes. - Ecms
Bulk GetUpload Property Rules Builder Rules V20230105Behavior Ecms Bulk Upload - Uploads a ZIP archive with objects to an existing data set. The target data set stores objects as key-value pairs. The path to an object in the ZIP archive is a key, and the content of an object is a value. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - Ecms
Database GetProperty Rules Builder Rules V20230105Behavior Ecms Database - Edge Connect Message Store is available for
Internet of Things: Edge Connect
users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB.ecmsDatabase
specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure theecmsDataset
behavior to specify a default data set for requests. This behavior cannot be used in includes. - Ecms
Dataset GetProperty Rules Builder Rules V20230105Behavior Ecms Dataset - Specifies a default data set for requests to this property unless indicated otherwise in the URL. To access objects in this data set, you can skip the data set name in the URLs. To access objects in a different data set within a database, pass the data set name in the header, query parameter, or a regular expression pattern matching a URL segment. You can also configure the
ecmsDatabase
behavior to specify a default database for requests. This behavior cannot be used in includes. - Ecms
Object GetKey Property Rules Builder Rules V20230105Behavior Ecms Object Key - Defines a regular expression to match object keys in custom URLs and to access objects in a data set. You can point custom URLs to access proper values in the target data set. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - Edge
Connect GetProperty Rules Builder Rules V20230105Behavior Edge Connect - Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
- Edge
Load GetBalancing Advanced Property Rules Builder Rules V20230105Behavior Edge Load Balancing Advanced - This behavior implements customized Edge Load Balancing features. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior cannot be used in includes.
- Edge
Load GetBalancing Data Center Property Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center - The Edge Load Balancing module allows you to specify groups of data centers that implement load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- Edge
Load GetBalancing Origin Property Rules Builder Rules V20230105Behavior Edge Load Balancing Origin - The Edge Load Balancing module allows you to implement groups of data centers featuring load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Edge Origin Authorization - Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
- Edge
Redirector GetProperty Rules Builder Rules V20230105Behavior Edge Redirector - This behavior enables the
Edge Redirector Cloudlet
application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control the Edge Redirector withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - Edge
Scape GetProperty Rules Builder Rules V20230105Behavior Edge Scape EdgeScape
allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a specialX-Akamai-Edgescape
header to the origin server encoding relevant details about the end-user client as key-value pairs. This behavior can be used in includes.- Edge
Side GetIncludes Property Rules Builder Rules V20230105Behavior Edge Side Includes - Allows edge servers to process edge side include (ESI) code to generate dynamic content. To apply this behavior, you need to match on a
contentType
,path
, orfilename
. Since this behavior requires more parsing time, you should not apply it to pages that lack ESI code, or to any non-HTML content. This behavior can be used in includes. - Edge
Worker GetProperty Rules Builder Rules V20230105Behavior Edge Worker EdgeWorkers
are JavaScript applications that allow you to manipulate your web traffic on edge servers outside of Property Manager behaviors, and deployed independently from your configuration's logic. This behavior applies an EdgeWorker to a set of edge requests. This behavior cannot be used in includes.- Enhanced
Akamai GetProtocol Property Rules Builder Rules V20230105Behavior Enhanced Akamai Protocol - Enables the Enhanced Akamai Protocol, a suite of advanced routing and transport optimizations that increase your website's performance and reliability. It is only available to specific applications, and requires a special routing from edge to origin. This behavior can be used in includes.
- Enhanced
Proxy GetDetection Property Rules Builder Rules V20230105Behavior Enhanced Proxy Detection - Enhanced Proxy Detection (EPD) leverages the GeoGuard service provided by GeoComply to add proxy detection and location spoofing protection. It identifies requests for your content that have been redirected from an unwanted source through a proxy. You can then allow, deny, or redirect these requests. This behavior can be used in includes.
- Epd
Forward GetHeader Enrichment Property Rules Builder Rules V20230105Behavior Epd Forward Header Enrichment - This behavior identifies unwanted requests from an anonymous proxy. This and the
enhancedProxyDetection
behavior work together and need to be included either in the same rule, or in the default one. This behavior can be used in includes. - Fail
Action GetProperty Rules Builder Rules V20230105Behavior Fail Action - Specifies how to respond when the origin is not available: by serving stale content, by serving an error page, or by redirecting. To apply this behavior, you should match on an
originTimeout
ormatchResponseCode
. This behavior can be used in includes. - Failover
Bot GetManager Feature Compatibility Property Rules Builder Rules V20230105Behavior Failover Bot Manager Feature Compatibility - Ensures that functionality such as challenge authentication and reset protocol work with a failover product property you use to create an alternate hostname. Apply it to any properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- Fast
Invalidate GetProperty Rules Builder Rules V20230105Behavior Fast Invalidate - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- First
Party GetMarketing Property Rules Builder Rules V20230105Behavior First Party Marketing - Enables the Cloud Marketing Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketingPlus
behavior, which integrates better with both MediaMath and its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - First
Party GetMarketing Plus Property Rules Builder Rules V20230105Behavior First Party Marketing Plus - Enables the Cloud Marketing Plus Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketing
behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - Forward
Rewrite GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite - The Forward Rewrite Cloudlet allows you to conditionally modify the forward path in edge content without affecting the URL that displays in the user's address bar. If Cloudlets are available on your contract, choose
Your services
>Edge logic Cloudlets
to control how this feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - Front
End GetOptimization Property Rules Builder Rules V20230105Behavior Front End Optimization - This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
- G2oheader
Get
Property Rules Builder Rules V20230105Behavior G2oheader - The
signature header authentication
(g2o) security feature provides header-based verification of outgoing origin requests. Edge servers encrypt request data in a pre-defined header, which the origin uses to verify that the edge server processed the request. This behavior configures the request data, header names, encryption algorithm, and shared secret to use for verification. This behavior can be used in includes. - Global
Request GetNumber Property Rules Builder Rules V20230105Behavior Global Request Number - Generates a unique identifier for each request on the Akamai edge network, for use in logging and debugging. GRN identifiers follow the same format as Akamai's error reference strings, for example:
0.05313217.1567801841.1457a3
. You can use the Edge Diagnostics API'sTranslate error string
operation to get low-level details about any request. This behavior can be used in includes. - Graphql
Caching GetProperty Rules Builder Rules V20230105Behavior Graphql Caching - This behavior configures how to cache GraphQL-based API traffic. Enable
caching
for your GraphQL API traffic, along withallowPost
to cache POST responses. To configure REST API traffic, use therapid
behavior. This behavior can be used in includes. - Gzip
Response GetProperty Rules Builder Rules V20230105Behavior Gzip Response - Apply
gzip
compression to speed transfer time. This behavior applies best to text-based content such as HTML, CSS, and JavaScript, especially once files exceed about 10KB. Do not apply it to already compressed image formats, or to small files that would add more time to uncompress. To apply this behavior, you should match oncontentType
or the content'scacheability
. This behavior can be used in includes. - Hd
Data GetAdvanced Property Rules Builder Rules V20230105Behavior Hd Data Advanced - This behavior specifies Akamai XML metadata that can only be configured on your behalf by Akamai Professional Services. Unlike the
advanced
behavior, this may apply a different set of overriding metadata that executes in a post-processing phase. This behavior is for internal usage only. This behavior can be used in includes. - Health
Detection GetProperty Rules Builder Rules V20230105Behavior Health Detection - Monitors the health of your origin server by tracking unsuccessful attempts to contact it. Use this behavior to keep end users from having to wait several seconds before a forwarded request times out, or to reduce requests on the origin server when it is unavailable. This behavior can be used in includes.
- Hsaf
Eip GetBinding Property Rules Builder Rules V20230105Behavior Hsaf Eip Binding - Edge IP Binding works with a limited set of static IP addresses to distribute your content, which can be limiting in large footprint environments. This behavior sets Hash Serial and Forward (HSAF) for Edge IP Binding to deal with larger footprints. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- Http2
Get
Property Rules Builder Rules V20230105Behavior Http2 - Enables the HTTP/2 protocol, which reduces latency and improves efficiency. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
for guidance. This behavior cannot be used in includes. - Http3
Get
Property Rules Builder Rules V20230105Behavior Http3 - This enables the HTTP/3 protocol that uses QUIC. The behavior allows for improved performance and faster connection setup. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
and theProperty Manager documentation
for guidance. This behavior cannot be used in includes. - Http
Strict GetTransport Security Property Rules Builder Rules V20230105Behavior Http Strict Transport Security - Applies HTTP Strict Transport Security (HSTS), disallowing insecure HTTP traffic. Apply this to hostnames managed with Standard TLS or Enhanced TLS certificates. This behavior cannot be used in includes.
- Http
To GetHttps Upgrade Property Rules Builder Rules V20230105Behavior Http To Https Upgrade - Upgrades an HTTP edge request to HTTPS for the remainder of the request flow. Enable this behavior only if your origin supports HTTPS, and if your
origin
behavior is configured withoriginCertsToHonor
to verify SSL certificates. This behavior can be used in includes. - Im
Override GetProperty Rules Builder Rules V20230105Behavior Im Override - This specifies common query parameters that affect how
imageManager
transforms images, potentially overriding policy, width, format, or density request parameters. This also allows you to assign the value of one of the property'srule tree variables
to one of Image and Video Manager's own policy variables. This behavior can be used in includes. - Image
And GetVideo Manager Property Rules Builder Rules V20230105Behavior Image And Video Manager - This behavior can be used in includes.
- Image
Manager GetProperty Rules Builder Rules V20230105Behavior Image Manager - Optimizes images' size or file type for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching images using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. Once you apply Image and Video Manager to traffic, you can add theadvancedImMatch
to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes. - Image
Manager GetVideo Property Rules Builder Rules V20230105Behavior Image Manager Video - Optimizes videos managed by Image and Video Manager for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching videos using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. This behavior can be used in includes. - Include
Get
Property Rules Builder Rules V20230105Behavior Include - Includes let you reuse chunks of a property configuration that you can manage separately from the rest of the property rule tree. This behavior cannot be used in includes.
- Input
Validation GetProperty Rules Builder Rules V20230105Behavior Input Validation - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- Instant
Get
Property Rules Builder Rules V20230105Behavior Instant - The Instant feature allows you to prefetch content to the edge cache by adding link relation attributes to markup. For example: This behavior can be used in includes.
- Instant
Config GetProperty Rules Builder Rules V20230105Behavior Instant Config - Multi-Domain Configuration, also known as
InstantConfig
, allows you to apply property settings to all incoming hostnames based on a DNS lookup, without explicitly listing them among the property's hostnames. This behavior cannot be used in includes. - Large
File GetOptimization Property Rules Builder Rules V20230105Behavior Large File Optimization - The
Large File Optimization
(LFO) feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and you should apply it to anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files, and enable theuseVersioning
option while enforcing your own filename versioning policy. Make sure you meet all therequirements and best practices
for the LFO delivery. This behavior can be used in includes. - Large
File GetOptimization Advanced Property Rules Builder Rules V20230105Behavior Large File Optimization Advanced - The
Large File Optimization
feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and it's recommended for anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files. Note that it is best to useNetStorage
for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes. - Limit
Bit GetRate Property Rules Builder Rules V20230105Behavior Limit Bit Rate - Control the rate at which content serves out to end users, optionally varying the speed depending on the file size or elapsed download time. Each bit rate specified in the
bitrateTable
array corresponds to athresholdTable
entry that activates it. You can use this behavior to prevent media downloads from progressing faster than they are viewed, for example, or to differentiate various tiers of end-user experience. To apply this behavior, you should match on acontentType
,path
, orfilename
. This behavior can be used in includes. - Log
Custom GetProperty Rules Builder Rules V20230105Behavior Log Custom - Logs custom details from the origin response in the
Log Delivery Service
report. This behavior can be used in includes. - MPulse
Get
Property Rules Builder Rules V20230105Behavior MPulse mPulse
provides high-level performance analytics and predictive recommendations based on real end user data. See themPulse Quick Start
to set up mPulse on your website. This behavior cannot be used in includes.- Manifest
Personalization GetProperty Rules Builder Rules V20230105Behavior Manifest Personalization - Allows customers who use the Adaptive Media Delivery product to enhance content based on the capabilities of each end user's device. This behavior configures a
manifest
for both HLS Live and on-demand streaming. For more information, seeAdaptive Media Delivery
. This behavior can be used in includes. - Manifest
Rerouting GetProperty Rules Builder Rules V20230105Behavior Manifest Rerouting - This behavior works with
adScalerCircuitBreaker
. It delegates parts of the media delivery workflow, like ad insertion, to other technology partners. Akamai reroutes manifest file requests to partner platforms for processing prior to being delivered. Rerouting simplifies the workflow and improves the media streaming experience. This behavior cannot be used in includes. - Manual
Server GetPush Property Rules Builder Rules V20230105Behavior Manual Server Push - With the
http2
behavior enabled, this loads a specified set of objects into the client browser's cache. To apply this behavior, you should match on apath
orfilename
. This behavior cannot be used in includes. - Media
Acceleration GetProperty Rules Builder Rules V20230105Behavior Media Acceleration - Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
- Media
Acceleration GetQuic Optout Property Rules Builder Rules V20230105Behavior Media Acceleration Quic Optout - When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
- Media
Client GetProperty Rules Builder Rules V20230105Behavior Media Client - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- Media
File GetRetrieval Optimization Property Rules Builder Rules V20230105Behavior Media File Retrieval Optimization - Media File Retrieval Optimization (MFRO) speeds the delivery of large media files by relying on caches of partial objects. You should use it for files larger than 100 MB. It's required for files larger than 1.8 GB, and works best with
NetStorage
. To apply this behavior, you should match on afileExtension
. This behavior can be used in includes. - Media
Origin GetFailover Property Rules Builder Rules V20230105Behavior Media Origin Failover - Specifies how edge servers respond when the origin is unresponsive, or suffers from server or content errors. You can specify how many times to retry, switch to a backup origin hostname, or configure a redirect. This behavior can be used in includes.
- Metadata
Caching GetProperty Rules Builder Rules V20230105Behavior Metadata Caching - This behavior reduces time spent waiting for the initial response, also known as time to first byte, during peak traffic events. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- Mobile
Sdk GetPerformance Property Rules Builder Rules V20230105Behavior Mobile Sdk Performance - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- Modify
Incoming GetRequest Header Property Rules Builder Rules V20230105Behavior Modify Incoming Request Header - Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
- Modify
Incoming GetResponse Header Property Rules Builder Rules V20230105Behavior Modify Incoming Response Header - Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
- Modify
Outgoing GetRequest Header Property Rules Builder Rules V20230105Behavior Modify Outgoing Request Header - Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
- Modify
Outgoing GetResponse Header Property Rules Builder Rules V20230105Behavior Modify Outgoing Response Header - Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
- Modify
Via GetHeader Property Rules Builder Rules V20230105Behavior Modify Via Header - Removes or renames the HTTP
Via
headers used to inform the server of proxies through which the request was sent to the origin. This behavior can be used in includes. - Origin
Get
Property Rules Builder Rules V20230105Behavior Origin - Specify the hostname and settings used to contact the origin once service begins. You can use your own origin,
NetStorage
, an Edge Load Balancing origin, or a SaaS dynamic origin. This behavior can be used in includes. - Origin
Characteristics GetProperty Rules Builder Rules V20230105Behavior Origin Characteristics - Specifies characteristics of the origin. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior cannot be used in includes.
- Origin
Characteristics GetWsd Property Rules Builder Rules V20230105Behavior Origin Characteristics Wsd - Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
- Origin
Failure GetRecovery Method Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Method - Origin Failover requires that you set up a separate rule containing origin failure recovery methods. You also need to set up the Origin Failure Recovery Policy behavior in a separate rule with a desired match criteria, and select the desired failover method. You can do this using Property Manager. Learn more about this process in
Adaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryPolicy
member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes. - Origin
Failure GetRecovery Policy Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Policy - Configures how to detect an origin failure, in which case the
originFailureRecoveryMethod
behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process inAdaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryMethod
member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes. - Origin
Ip GetAcl Property Rules Builder Rules V20230105Behavior Origin Ip Acl - Origin IP Access Control List limits the traffic to your origin. It only allows requests from specific edge servers that are configured as part of a supernet defined by CIDR blocks. This behavior can be used in includes.
- Persistent
Client GetConnection Property Rules Builder Rules V20230105Behavior Persistent Client Connection - This behavior activates
persistent connections
between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with thepersistentConnection
behavior, which configures persistent connections for the entire journey from origin to edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - Persistent
Connection GetProperty Rules Builder Rules V20230105Behavior Persistent Connection - This behavior enables more efficient
persistent connections
from origin to edge server to client. Compare with thepersistentClientConnection
behavior, which customizes persistent connections from edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - Personally
Identifiable GetInformation Property Rules Builder Rules V20230105Behavior Personally Identifiable Information - Marks content covered by the current rule as sensitive
personally identifiable information
that needs to be treated as secure and private. That includes anything involving personal information: name, social security number, date and place of birth, mother's maiden name, biometric data, or any other data linked to an individual. If you attempt to save a property with such a rule that also caches or logs sensitive content, the added behavior results in a validation error. This behavior cannot be used in includes. - Phased
Release GetProperty Rules Builder Rules V20230105Behavior Phased Release - The Phased Release Cloudlet provides gradual and granular traffic management to an alternate origin in near real time. Use the
Cloudlets API
or the Cloudlets Policy Manager application withinControl Center
to set up your Cloudlets policies. This behavior cannot be used in includes. - Preconnect
Get
Property Rules Builder Rules V20230105Behavior Preconnect - With the
http2
behavior enabled, this requests a specified set of domains that relate to your property hostname, and keeps the connection open for faster loading of content from those domains. This behavior can be used in includes. - Predictive
Content GetDelivery Property Rules Builder Rules V20230105Behavior Predictive Content Delivery - Improves user experience and reduces the cost of downloads by enabling mobile devices to predictively fetch and cache content from catalogs managed by Akamai servers. You can't use this feature if in the
segmentedMediaOptimization
behavior, the value forbehavior
is set toLIVE
. This behavior can be used in includes. - Predictive
Prefetching GetProperty Rules Builder Rules V20230105Behavior Predictive Prefetching - This behavior potentially reduces the client's page load time by pre-caching objects based on historical data for the page, not just its current set of referenced objects. It also detects second-level dependencies, such as objects retrieved by JavaScript. This behavior can be used in includes.
- Prefetch
Get
Property Rules Builder Rules V20230105Behavior Prefetch - Instructs edge servers to retrieve content linked from requested pages as they load, rather than waiting for separate requests for the linked content. This behavior applies depending on the rule's set of matching conditions. Use in conjunction with the
prefetchable
behavior, which specifies the set of objects to prefetch. This behavior can be used in includes. - Prefetchable
Get
Property Rules Builder Rules V20230105Behavior Prefetchable - Allow matching objects to prefetch into the edge cache as the parent page that links to them loads, rather than waiting for a direct request. This behavior applies depending on the rule's set of matching conditions. Use
prefetch
to enable the overall behavior for parent pages that contain links to the object. To apply this behavior, you need to match on afilename
orfileExtension
. This behavior can be used in includes. - Prefresh
Cache GetProperty Rules Builder Rules V20230105Behavior Prefresh Cache - Refresh cached content before its time-to-live (TTL) expires, to keep end users from having to wait for the origin to provide fresh content. This behavior can be used in includes.
- Quality
Get
Property Rules Builder Rules V20230105Behavior Quality - This behavior can be used in includes.
- Quic
Beta GetProperty Rules Builder Rules V20230105Behavior Quic Beta - For a share of responses, includes an
Alt-Svc
header for compatible clients to initiate subsequent sessions using the QUIC protocol. This behavior cannot be used in includes. - Random
Seek GetProperty Rules Builder Rules V20230105Behavior Random Seek - Optimizes
.flv
and.mp4
files to allow random jump-point navigation. This behavior can be used in includes. - Rapid
Get
Property Rules Builder Rules V20230105Behavior Rapid - The
Akamai API Gateway
allows you to configure API traffic delivered over the Akamai network. Apply this behavior to a set of API assets, then use Akamai'sAPI Endpoints API
to configure how the traffic responds. Use theAPI Keys and Traffic Management API
to control access to your APIs. This behavior cannot be used in includes. - Read
Timeout GetProperty Rules Builder Rules V20230105Behavior Read Timeout - This behavior specifies how long the edge server should wait for a response from the requesting forward server after a connection has already been established. This behavior can be used in includes.
- Real
Time GetReporting Property Rules Builder Rules V20230105Behavior Real Time Reporting - This enables Real-Time Reporting for Akamai
Cloud Embed
customers. The behavior can only be configured on your behalf by Akamai Professional Services. You can access real-time reports data for that base configuration withMedia Delivery Reports API
. This behavior is for internal usage only. This behavior can be used in includes. - Real
User GetMonitoring Property Rules Builder Rules V20230105Behavior Real User Monitoring - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- Redirect
Get
Property Rules Builder Rules V20230105Behavior Redirect - Respond to the client request with a redirect without contacting the origin. Specify the redirect as a path expression starting with a
/
character relative to the current root, or as a fully qualified URL. This behavior relies primarily ondestinationHostname
anddestinationPath
to manipulate the hostname and path independently. This behavior can be used in includes. - Redirectplus
Get
Property Rules Builder Rules V20230105Behavior Redirectplus - Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as
redirect
, but allows you to usevariables
to express the redirectdestination
's component values more concisely. This behavior can be used in includes. - Referer
Checking GetProperty Rules Builder Rules V20230105Behavior Referer Checking - Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
- Remove
Query GetParameter Property Rules Builder Rules V20230105Behavior Remove Query Parameter - Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
- Remove
Vary GetProperty Rules Builder Rules V20230105Behavior Remove Vary - By default, responses that feature a
Vary
header value of anything other thanAccept-Encoding
and a correspondingContent-Encoding: gzip
header aren't cached on edge servers.Vary
headers indicate when a URL's content varies depending on some variable, such as whichUser-Agent
requests it. This behavior simply removes theVary
header to make responses cacheable. This behavior can be used in includes. - Report
Get
Property Rules Builder Rules V20230105Behavior Report - Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
- Request
Control GetProperty Rules Builder Rules V20230105Behavior Request Control - The Request Control Cloudlet allows you to control access to your web content based on the incoming request's IP or geographic location. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control how the feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - Request
Type GetMarker Property Rules Builder Rules V20230105Behavior Request Type Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. When using thedownloadCompleteMarker
behavior to log successful downloads, this related behavior identifies download or campaign server types in aggregated and individual reports. This behavior can be used in includes. - Resource
Optimizer GetProperty Rules Builder Rules V20230105Behavior Resource Optimizer - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- Resource
Optimizer GetExtended Compatibility Property Rules Builder Rules V20230105Behavior Resource Optimizer Extended Compatibility - This enhances the standard version of the
resourceOptimizer
behavior to support the compression of additional file formats and address some compatibility issues. This behavior can be used in includes. - Response
Code GetProperty Rules Builder Rules V20230105Behavior Response Code - Change the existing response code. For example, if your origin sends a
301
permanent redirect, this behavior can change it on the edge to a temporary302
redirect. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Response Cookie - Set a cookie to send downstream to the client with either a fixed value or a unique stamp. This behavior can be used in includes.
- Restrict
Object GetCaching Property Rules Builder Rules V20230105Behavior Restrict Object Caching - You need this behavior to deploy the Object Caching product. It disables serving HTML content and limits the maximum object size to 100MB. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- Return
Cache GetStatus Property Rules Builder Rules V20230105Behavior Return Cache Status - Generates a response header with information about cache status. Among other things, this can tell you whether the response came from the Akamai cache, or from the origin. Status values report with either of these forms of syntax, depending for example on whether you're deploying traffic using
sureRoute
ortieredDistribution
: This behavior can be used in includes. - Rewrite
Url GetProperty Rules Builder Rules V20230105Behavior Rewrite Url - Modifies the path of incoming requests to forward to the origin. This helps you offload URL-rewriting tasks to the edge to increase the origin server's performance, allows you to redirect links to different targets without changing markup, and hides your original directory structure. This behavior can be used in includes.
- Rum
Custom GetProperty Rules Builder Rules V20230105Behavior Rum Custom - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- Saas
Definitions GetProperty Rules Builder Rules V20230105Behavior Saas Definitions - Configures how the Software as a Service feature identifies
customers
,applications
, andusers
. A different set of options is available for each type of targeted request, each enabled with theaction
-suffixed option. In each case, you can usePATH
,COOKIE
,QUERY_STRING
, orHOSTNAME
components as identifiers, ordisable
the SaaS behavior for certain targets. If you rely on aHOSTNAME
, you also have the option of specifying aCNAME chain
rather than an individual hostname. The various options suffixedregex
andreplace
subsequently remove the identifier from the request. This behavior requires a siblingorigin
behavior whoseoriginType
option is set toSAAS_DYNAMIC_ORIGIN
. This behavior cannot be used in includes. - Sales
Force GetCommerce Cloud Client Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Client - If you use the Salesforce Commerce Cloud platform for your origin content, this behavior allows your edge content managed by Akamai to contact directly to origin. This behavior cannot be used in includes.
- Sales
Force GetCommerce Cloud Provider Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider - This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- Sales
Force GetCommerce Cloud Provider Host Header Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider Host Header - Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- Save
Post GetDca Processing Property Rules Builder Rules V20230105Behavior Save Post Dca Processing - Used in conjunction with the
cachePost
behavior, this behavior allows the body of POST requests to be processed through Dynamic Content Assembly. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes. - Schedule
Invalidation GetProperty Rules Builder Rules V20230105Behavior Schedule Invalidation - Specifies when cached content that satisfies a rule's criteria expires, optionally at repeating intervals. In addition to periodic cache flushes, you can use this behavior to minimize potential conflicts when related objects expire at different times. This behavior can be used in includes.
- Script
Management GetProperty Rules Builder Rules V20230105Behavior Script Management - Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. See
Script Management API
for more information. This behavior cannot be used in includes. - Segmented
Content GetProtection Property Rules Builder Rules V20230105Behavior Segmented Content Protection - Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
- Segmented
Media GetOptimization Property Rules Builder Rules V20230105Behavior Segmented Media Optimization - Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
- Segmented
Media GetStreaming Prefetch Property Rules Builder Rules V20230105Behavior Segmented Media Streaming Prefetch - Prefetches HLS and DASH media stream manifest and segment files, accelerating delivery to end users. For prefetching to work, your origin media's response needs to specify
CDN-Origin-Assist-Prefetch-Path
headers with each URL to prefetch, expressed as either a relative or absolute path. This behavior can be used in includes. - Set
Variable GetProperty Rules Builder Rules V20230105Behavior Set Variable - Modify a variable to insert into subsequent fields within the rule tree. Use this behavior to specify the predeclared
variableName
and determine from where to derive its new value. Based on thisvalueSource
, you can either generate the value, extract it from some part of the incoming request, assign it from another variable (including a set of built-in system variables), or directly specify its text. Optionally choose atransform
function to modify the value once. SeeSupport for variables
for more information. This behavior can be used in includes. - Shutr
Get
Property Rules Builder Rules V20230105Behavior Shutr - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- Simulate
Error GetCode Property Rules Builder Rules V20230105Behavior Simulate Error Code - This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- Site
Shield GetProperty Rules Builder Rules V20230105Behavior Site Shield - This behavior implements the
Site Shield
feature, which helps prevent non-Akamai machines from contacting your origin. You get an email with a list of Akamai servers allowed to contact your origin, with which you establish an Access Control List on your firewall to prevent any other requests. This behavior cannot be used in includes. - Standard
Tls GetMigration Property Rules Builder Rules V20230105Behavior Standard Tls Migration - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- Standard
Tls GetMigration Override Property Rules Builder Rules V20230105Behavior Standard Tls Migration Override - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- Strict
Header GetParsing Property Rules Builder Rules V20230105Behavior Strict Header Parsing - This behavior specifies how the edge servers should handle requests containing improperly formatted or invalid headers that don’t comply with
RFC 9110
. This behavior can be used in includes. - Sub
Customer GetProperty Rules Builder Rules V20230105Behavior Sub Customer - When positioned in a property's top-level default rule, enables various
Cloud Embed
features that allow you to leverage Akamai's CDN architecture for your own subcustomers. This behavior's options allow you to use Cloud Embed to configure your subcustomers' content. Once enabled, you can use theAkamai Cloud Embed API
(ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also thedynamicWebContent
behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes. - Sure
Route GetProperty Rules Builder Rules V20230105Behavior Sure Route - The
SureRoute
feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conductsraces
to identify alternative paths to use in case of a transmission failure. These races increase origin traffic slightly. This behavior cannot be used in includes. - Tcp
Optimization GetProperty Rules Builder Rules V20230105Behavior Tcp Optimization - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- Tea
Leaf GetProperty Rules Builder Rules V20230105Behavior Tea Leaf - Allows IBM Tealeaf Customer Experience on Cloud to record HTTPS requests and responses for Akamai-enabled properties. Recorded data becomes available in your IBM Tealeaf account. This behavior cannot be used in includes.
- Tiered
Distribution GetProperty Rules Builder Rules V20230105Behavior Tiered Distribution - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This behavior cannot be used in includes. - Tiered
Distribution GetAdvanced Property Rules Builder Rules V20230105Behavior Tiered Distribution Advanced - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This advanced behavior provides a wider set of options thantieredDistribution
. This behavior is for internal usage only. This behavior can be used in includes. - Tiered
Distribution GetCustomization Property Rules Builder Rules V20230105Behavior Tiered Distribution Customization - With Tiered Distribution, Akamai edge servers retrieve cached content from other Akamai servers, rather than directly from the origin. This behavior sets custom Tiered Distribution maps (TD0) and migrates TD1 maps configured with
advanced features
to Cloud Wrapper. You need to enablecloudWrapper
within the same rule. This behavior is for internal usage only. This behavior can be used in includes. - Timeout
Get
Property Rules Builder Rules V20230105Behavior Timeout - Sets the HTTP connect timeout. This behavior can be used in includes.
- Uid
Configuration GetProperty Rules Builder Rules V20230105Behavior Uid Configuration - This behavior allows you to extract unique identifier (UID) values from live traffic, for use in OTA applications. Note that you are responsible for maintaining the security of any data that may identify individual users. This behavior cannot be used in includes.
- Validate
Entity GetTag Property Rules Builder Rules V20230105Behavior Validate Entity Tag - Instructs edge servers to compare the request's
ETag
header with that of the cached object. If they differ, the edge server sends a new copy of the object. This validation occurs in addition to the default validation ofLast-Modified
andIf-Modified-Since
headers. This behavior can be used in includes. - Verify
Json GetWeb Token Property Rules Builder Rules V20230105Behavior Verify Json Web Token - This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
- Verify
Json GetWeb Token For Dcp Property Rules Builder Rules V20230105Behavior Verify Json Web Token For Dcp - This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing
IoT Edge Connect
, which you use thedcp
behavior to configure. You can specify the location in a request to pass a JSON web token (JWT), collections of public keys to verify the integrity of this token, and specific claims to extract from it. Use theverifyJsonWebToken
behavior for other JWT validation. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Verify Token Authorization - Verifies Auth 2.0 tokens. This behavior can be used in includes.
- Virtual
Waiting GetRoom Property Rules Builder Rules V20230105Behavior Virtual Waiting Room - This behavior helps you maintain business continuity for dynamic applications in high-demand situations such as flash sales. It decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a request processing mechanism that prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control Virtual Waitig Room withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - Virtual
Waiting GetRoom With Edge Workers Property Rules Builder Rules V20230105Behavior Virtual Waiting Room With Edge Workers - This behavior allows you to configure the
virtualWaitingRoom
behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes. - Visitor
Prioritization GetProperty Rules Builder Rules V20230105Behavior Visitor Prioritization - The
Visitor Prioritization Cloudlet
decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - Visitor
Prioritization GetFifo Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo - (BETA) The
Visitor Prioritization Cloudlet (FIFO)
decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a fair request processing mechanism, which prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization (FIFO) withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - Visitor
Prioritization GetFifo Standalone Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo Standalone - This behavior cannot be used in includes.
- Watermarking
Get
Property Rules Builder Rules V20230105Behavior Watermarking - Adds watermarking for each valid user's content. Content segments are delivered from different sources using a pattern unique to each user, based on a watermarking token included in each request. If your content is pirated or redistributed, you can forensically analyze the segments to extract the pattern, and identify the user who leaked the content. This behavior can be used in includes.
- Web
Application GetFirewall Property Rules Builder Rules V20230105Behavior Web Application Firewall - This behavior implements a suite of security features that blocks threatening HTTP and HTTPS requests. Use it as your primary firewall, or in addition to existing security measures. Only one referenced configuration is allowed per property, so this behavior typically belongs as part of its default rule. This behavior cannot be used in includes.
- Web
Sockets GetProperty Rules Builder Rules V20230105Behavior Web Sockets - The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
- Webdav
Get
Property Rules Builder Rules V20230105Behavior Webdav - Web-based Distributed Authoring and Versioning (WebDAV) is a set of extensions to the HTTP protocol that allows users to collaboratively edit and manage files on remote web servers. This behavior enables WebDAV, and provides support for the following additional request methods: PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. To apply this behavior, you need to match on a
requestMethod
. This behavior can be used in includes.
- ad
Scaler GetCircuit Breaker Property Rules Builder Rules V20230105Behavior Ad Scaler Circuit Breaker - This behavior works with
manifestRerouting
to provide the scale and reliability of Akamai network while simultaneously allowing third party partners to modify the requested media content with value-added features. TheadScalerCircuitBreaker
behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object. This behavior cannot be used in includes. - adaptive
Acceleration GetProperty Rules Builder Rules V20230105Behavior Adaptive Acceleration - Adaptive Acceleration uses HTTP/2 server push functionality with Ion properties to pre-position content and improve the performance of HTML page loading based on real user monitoring (RUM) timing data. It also helps browsers to preconnect to content that’s likely needed for upcoming requests. To use this behavior, make sure you enable the
http2
behavior. Use theAdaptive Acceleration API
to report on the set of assets this feature optimizes. This behavior cannot be used in includes. - adaptive
Image GetCompression Property Rules Builder Rules V20230105Behavior Adaptive Image Compression Note: Starting from May 31, 2024, Adaptive Image Compression is no longer supported and the image compression configured through this functionality won't take place. As an alternative, we offer
Image & Video Manager
. It intelligently and automatically optimizes images and videos on the fly for every user. Reach out to your Akamai representatives for more information on this product. This behavior can be used in includes.- advanced
Get
Property Rules Builder Rules V20230105Behavior Advanced - This specifies Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- aggregated
Reporting GetProperty Rules Builder Rules V20230105Behavior Aggregated Reporting - Configure a custom report that collects traffic data. The data is based on one to four variables, such as
sum
,average
,min
, andmax
. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes. - akamaizer
Get
Property Rules Builder Rules V20230105Behavior Akamaizer - This allows you to run regular expression substitutions over web pages. To apply this behavior, you need to match on a
contentType
. Contact Akamai Professional Services for help configuring the Akamaizer. See also theakamaizerTag
behavior. This behavior is for internal usage only. This behavior can be used in includes. - akamaizer
Tag GetProperty Rules Builder Rules V20230105Behavior Akamaizer Tag - This specifies HTML tags and replacement rules for hostnames used in conjunction with the
akamaizer
behavior. Contact Akamai Professional Services for help configuring the Akamaizer. This behavior is for internal usage only. This behavior can be used in includes. - all
Http GetIn Cache Hierarchy Property Rules Builder Rules V20230105Behavior All Http In Cache Hierarchy - Allow all HTTP request methods to be used for the edge's parent servers, useful to implement features such as
Site Shield
,SureRoute
, and Tiered Distribution. (See thesiteShield
,sureRoute
, andtieredDistribution
behaviors.) This behavior can be used in includes. - allow
Cloudlets GetOrigins Property Rules Builder Rules V20230105Behavior Allow Cloudlets Origins - Allows Cloudlets Origins to determine the criteria, separately from the Property Manager, under which alternate
origin
definitions are assigned. This behavior cannot be used in includes. - allow
Delete GetProperty Rules Builder Rules V20230105Behavior Allow Delete - Allow HTTP requests using the DELETE method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any DELETE requests pass to the origin. See also the
allowOptions
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Https GetCache Key Sharing Property Rules Builder Rules V20230105Behavior Allow Https Cache Key Sharing - HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
- allow
Https GetDowngrade Property Rules Builder Rules V20230105Behavior Allow Https Downgrade - Passes HTTPS requests to origin as HTTP. This is useful when incorporating Standard TLS or Akamai's shared certificate delivery security with an origin that serves HTTP traffic. This behavior can be used in includes.
- allow
Options GetProperty Rules Builder Rules V20230105Behavior Allow Options - GET, HEAD, and OPTIONS requests are allowed by default. All other HTTP methods result in a 501 error. For full support of Cross-Origin Resource Sharing (CORS), you need to allow requests that use the OPTIONS method. If you're using the
corsSupport
behavior, do not disable OPTIONS requests. The response to an OPTIONS request is not cached, so the request always goes through the Akamai network to your origin, unless you use theconstructResponse
behavior to send responses directly from the Akamai network. See also theallowDelete
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Patch GetProperty Rules Builder Rules V20230105Behavior Allow Patch - Allow HTTP requests using the PATCH method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PATCH requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Post GetProperty Rules Builder Rules V20230105Behavior Allow Post - Allow HTTP requests using the POST method. By default, GET, HEAD, and OPTIONS requests are allowed, and POST requests are denied with 403 error. All other methods result in a 501 error. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPut
behaviors. This behavior can be used in includes. - allow
Put GetProperty Rules Builder Rules V20230105Behavior Allow Put - Allow HTTP requests using the PUT method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PUT requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPost
behaviors. This behavior can be used in includes. - allow
Transfer GetEncoding Property Rules Builder Rules V20230105Behavior Allow Transfer Encoding - Controls whether to allow or deny Chunked Transfer Encoding (CTE) requests to pass to your origin. If your origin supports CTE, you should enable this behavior. This behavior also protects against a known issue when pairing
http2
andwebdav
behaviors within the same rule tree, in which case it's required. This behavior can be used in includes. - alt
Svc GetHeader Property Rules Builder Rules V20230105Behavior Alt Svc Header - Sets the maximum age value for the Alternative Services (
Alt-Svc
) header. This behavior can be used in includes. - api
Prioritization GetProperty Rules Builder Rules V20230105Behavior Api Prioritization - Enables the API Prioritization Cloudlet, which maintains continuity in user experience by serving an alternate static response when load is too high. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. Use this feature serve static API content, such as fallback JSON data. To serve non-API HTML content, use thevisitorPrioritization
behavior. This behavior can be used in includes. - application
Load GetBalancer Property Rules Builder Rules V20230105Behavior Application Load Balancer - Enables the Application Load Balancer Cloudlet, which automates load balancing based on configurable criteria. To configure this behavior, use either the Cloudlets Policy Manager or the
Cloudlets API
to set up a policy. This behavior cannot be used in includes. - audience
Segmentation GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation - Allows you to divide your users into different segments based on a persistent cookie. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. This behavior cannot be used in includes. - auto
Domain GetValidation Property Rules Builder Rules V20230105Behavior Auto Domain Validation - This behavior allows standard TLS domain validated certificates to renew automatically. Apply it after using the
Certificate Provisioning System
to request a certificate for a hostname. To provision certificates programmatically, see theCertificate Provisioning System API
. This behavior can be used in includes. - base
Directory GetProperty Rules Builder Rules V20230105Behavior Base Directory - Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
- boss
Beaconing GetProperty Rules Builder Rules V20230105Behavior Boss Beaconing - Triggers diagnostic data beacons for use with BOSS, Akamai's monitoring and diagnostics system. This behavior is for internal usage only. This behavior can be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Breadcrumbs - Provides per-HTTP transaction visibility into a request for content, regardless of how deep the request goes into the Akamai platform. The
Akamai-Request-BC
response header includes various data, such as network health and the location in the Akamai network used to serve content, which simplifies log review for troubleshooting. This behavior can be used in includes. - break
Connection GetProperty Rules Builder Rules V20230105Behavior Break Connection - This behavior simulates an origin connection problem, typically to test an accompanying
failAction
policy. This behavior can be used in includes. - brotli
Get
Property Rules Builder Rules V20230105Behavior Brotli - Accesses Brotli-compressed assets from your origin and caches them on edge servers. This doesn't compress resources within the content delivery network in real time. You need to set up Brotli compression separately on your origin. If a requesting client doesn't support Brotli, edge servers deliver non-Brotli resources. This behavior can be used in includes.
- cache
Error GetProperty Rules Builder Rules V20230105Behavior Cache Error - Caches the origin's error responses to decrease server load. Applies for 10 seconds by default to the following HTTP codes:
204
,305
,404
,405
,501
,502
,503
,504
, and505
. This behavior can be used in includes. - cache
Id GetProperty Rules Builder Rules V20230105Behavior Cache Id - Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
- cache
Key GetIgnore Case Property Rules Builder Rules V20230105Behavior Cache Key Ignore Case - By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that
File.html
andfile.html
use separate cache keys. Enabling this behavior forces URL components whose case varies to resolve to the same cache key. Enable this behavior if your origin server is already case-insensitive, such as those based on Microsoft IIS. This behavior can be used in includes. - cache
Key GetQuery Params Property Rules Builder Rules V20230105Behavior Cache Key Query Params - By default, cache keys are formed as URLs with full query strings. This behavior allows you to consolidate cached objects based on specified sets of query parameters. This behavior can be used in includes.
- cache
Key GetRewrite Property Rules Builder Rules V20230105Behavior Cache Key Rewrite - This behavior rewrites a default cache key's path. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- cache
Post GetProperty Rules Builder Rules V20230105Behavior Cache Post - By default, POST requests are passed to the origin. This behavior overrides the default, and allows you to cache POST responses. This behavior can be used in includes.
- cache
Redirect GetProperty Rules Builder Rules V20230105Behavior Cache Redirect - Controls the caching of HTTP 302 and 307 temporary redirects. By default, Akamai edge servers don't cache them. Enabling this behavior instructs edge servers to allow these redirects to be cached the same as HTTP 200 responses. This behavior can be used in includes.
- cache
Tag GetProperty Rules Builder Rules V20230105Behavior Cache Tag - This adds a cache tag to the requested object. With cache tags, you can flexibly fast purge tagged segments of your cached content. You can either define these tags with an
Edge-Cache-Tag
header at the origin server level, or use this behavior to directly add a cache tag to the object as the edge server caches it. ThecacheTag
behavior can only take a single value, including a variable. If you want to specify more tags for an object, add a few instances of this behavior to your configuration. This behavior can be used in includes. - cache
Tag GetVisible Property Rules Builder Rules V20230105Behavior Cache Tag Visible - Cache tags are comma-separated string values you define within an
Edge-Cache-Tag
header. You can use them to flexibly fast purge tagged segments of your cached content. You can either define these headers at the origin server level, or use themodifyOutgoingResponseHeader
behavior to configure them at the edge. Apply this behavior to confirm you're deploying the intended set of cache tags to your content. This behavior can be used in includes. - caching
Get
Property Rules Builder Rules V20230105Behavior Caching - Control content caching on edge servers: whether or not to cache, whether to honor the origin's caching headers, and for how long to cache. Note that any
NO_STORE
orBYPASS_CACHE
HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see theLearn about caching
section in the guide. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Central Authorization - Forward client requests to the origin server for authorization, along with optional
Set-Cookie
headers, useful when you need to maintain tight access control. The edge server forwards anIf-Modified-Since
header, to which the origin needs to respond with a304
(Not-Modified) HTTP status when authorization succeeds. If so, the edge server responds to the client with the cached object, since it does not need to be re-acquired from the origin. This behavior can be used in includes. - chase
Redirects GetProperty Rules Builder Rules V20230105Behavior Chase Redirects - Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
- client
Characteristics GetProperty Rules Builder Rules V20230105Behavior Client Characteristics - Specifies characteristics of the client ecosystem. Akamai uses this information to optimize your metadata configuration, which may result in better end-user performance. This behavior can be used in includes.
- cloud
Interconnects GetProperty Rules Builder Rules V20230105Behavior Cloud Interconnects - Cloud Interconnects forwards traffic from edge servers to your cloud origin through Private Network Interconnects (PNIs), helping to reduce the egress costs at the origin. Supports origins hosted by Google Cloud Provider (GCP). This behavior cannot be used in includes.
- cloud
Wrapper GetProperty Rules Builder Rules V20230105Behavior Cloud Wrapper Cloud Wrapper
maximizes origin offload for large libraries of video, game, and software downloads by optimizing data caches in regions nearest to your origin. You can't use this behavior in conjunction withsureRoute
ortieredDistribution
. This behavior cannot be used in includes.- cloud
Wrapper GetAdvanced Property Rules Builder Rules V20230105Behavior Cloud Wrapper Advanced - Your account representative uses this behavior to implement a customized failover configuration on your behalf. Use Cloud Wrapper Advanced with an enabled
cloudWrapper
behavior in the same rule. This behavior is for internal usage only. This behavior cannot be used in includes. - conditional
Origin GetProperty Rules Builder Rules V20230105Behavior Conditional Origin - This behavior cannot be used in includes.
- construct
Response GetProperty Rules Builder Rules V20230105Behavior Construct Response - This behavior constructs an HTTP response, complete with HTTP status code and body, to serve from the edge independently of your origin. For example, you might want to send a customized response if the URL doesn't point to an object on the origin server, or if the end user is not authorized to view the requested content. You can use it with all request methods you allow for your property, including POST. For more details, see the
allowOptions
,allowPatch
,allowPost
,allowPut
, andallowDelete
behaviors. This behavior can be used in includes. - content
Characteristics GetProperty Rules Builder Rules V20230105Behavior Content Characteristics - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetAmd Property Rules Builder Rules V20230105Behavior Content Characteristics Amd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetDd Property Rules Builder Rules V20230105Behavior Content Characteristics Dd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetWsd Large File Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Large File - Specifies characteristics of the delivered content, specifically targeted to delivering large files. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetWsd Live Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Live - Specifies characteristics of the delivered content, specifically targeted to delivering live video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetWsd Vod Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Vod - Specifies characteristics of the delivered content, specifically targeted to delivering on-demand video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Pre GetPosition Property Rules Builder Rules V20230105Behavior Content Pre Position - Content Preposition. This behavior can be used in includes.
- content
Targeting GetProtection Property Rules Builder Rules V20230105Behavior Content Targeting Protection - Content Targeting is based on
EdgeScape
, Akamai's location-based access control system. You can use it to allow or deny access to a set of geographic regions or IP addresses. This behavior can be used in includes. - cors
Support GetProperty Rules Builder Rules V20230105Behavior Cors Support - Cross-origin resource sharing (CORS) allows web pages in one domain to access restricted resources from your domain. Specify external origin hostnames, methods, and headers that you want to accept via HTTP response headers. Full support of CORS requires allowing requests that use the OPTIONS method. See
allowOptions
. This behavior can be used in includes. - cp
Code GetProperty Rules Builder Rules V20230105Behavior Cp Code - Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. You receive an initial CP code when purchasing Akamai, and you can run the
Create a new CP code
operation to generate more. This behavior applies any valid CP code, either as required as a default at the top of the rule tree, or subsequently to override the default. For a CP code to be valid, it needs to be assigned the same contract and product as the property, and the group needs access to it. For available values, run theList CP codes
operation. This behavior can be used in includes. - custom
Behavior GetProperty Rules Builder Rules V20230105Behavior Custom Behavior - Allows you to insert a customized XML metadata behavior into any property's rule tree. Talk to your Akamai representative to implement the customized behavior. Once it's ready, run PAPI's
List custom behaviors
operation, then apply the relevantbehaviorId
value from the response within the currentcustomBehavior
. SeeCustom behaviors and overrides
for guidance on custom metadata behaviors. This behavior can be used in includes. - datastream
Get
Property Rules Builder Rules V20230105Behavior Datastream - The
DataStream
reporting service provides real-time logs on application activity, including aggregated metrics on complete request and response cycles and origin response times. Apply this behavior to report on this set of traffic. Use theDataStream API
to aggregate the data. This behavior cannot be used in includes. - dcp
Get
Property Rules Builder Rules V20230105Behavior Dcp - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (TheIoT Edge Connect API
allows programmatic access.) This behavior allows you to select previously reserved namespaces and set the protocols for users to publish and receive messages within these namespaces. Use theverifyJsonWebTokenForDcp
behavior to control access. This behavior cannot be used in includes. - dcp
Auth GetHmac Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Hmac Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then generates a hash value based on the selected algorithm, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth GetRegex Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Regex Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then transforms the string based on a regular expression search pattern, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth GetSubstring Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Substring Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then extracts a substring, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth GetVariable Extractor Property Rules Builder Rules V20230105Behavior Dcp Auth Variable Extractor - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. When enabled, this behavior allows end users to authenticate their requests with valid x509 client certificates. Either a client identifier or access authorization groups are required to make the request valid. This behavior cannot be used in includes. - dcp
Default GetAuthz Groups Property Rules Builder Rules V20230105Behavior Dcp Default Authz Groups - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior defines a set of default authorization groups to add to each request the property configuration controls. These groups have access regardless of the authentication method you use, either JWT using theverifyJsonWebTokenForDcp
behavior, or mutual authentication using thedcpAuthVariableExtractor
behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes. - dcp
Dev GetRelations Property Rules Builder Rules V20230105Behavior Dcp Dev Relations - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior allows Akamai-external clients to use developer test accounts in a shared environment. In conjunction withverifyJsonWebTokenForDcp
, this behavior allows you to use your own JWTs in your requests, or those generated by Akamai. It lets you either enable the default JWT server for your test configuration by setting the authentication endpoint to a default path, or specify custom settings for your JWT server and the authentication endpoint. This behavior cannot be used in includes. - dcp
Real GetTime Auth Property Rules Builder Rules V20230105Behavior Dcp Real Time Auth - INTERNAL ONLY: The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior lets you configure the real time authentication to edge servers. This behavior is for internal usage only. This behavior cannot be used in includes. - delivery
Receipt GetProperty Rules Builder Rules V20230105Behavior Delivery Receipt - A static behavior that's required when specifying the Cloud Monitor module's (
edgeConnect
behavior. You can only apply this behavior if the property is marked as secure. SeeSecure property requirements
for guidance. This behavior can be used in includes. - deny
Access GetProperty Rules Builder Rules V20230105Behavior Deny Access - Assuming a condition in the rule matches, this denies access to the requested content. For example, a
userLocation
match paired with this behavior would deny requests from a specified part of the world. This behavior can be used in includes. - deny
Direct GetFailover Access Property Rules Builder Rules V20230105Behavior Deny Direct Failover Access - A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- device
Characteristic GetCache Id Property Rules Builder Rules V20230105Behavior Device Characteristic Cache Id - By default, source URLs serve as cache IDs on edge servers. Electronic Data Capture allows you to specify an additional set of device characteristics to generate separate cache keys. Use this in conjunction with the
deviceCharacteristicHeader
behavior. This behavior can be used in includes. - device
Characteristic GetHeader Property Rules Builder Rules V20230105Behavior Device Characteristic Header - Sends selected information about requesting devices to the origin server, in the form of an
X-Akamai-Device-Characteristics
HTTP header. Use in conjunction with thedeviceCharacteristicCacheId
behavior. This behavior can be used in includes. - dns
Async GetRefresh Property Rules Builder Rules V20230105Behavior Dns Async Refresh - Allow an edge server to use an expired DNS record when forwarding a request to your origin. The
type A
DNS record refreshesafter
content is served to the end user, so there is no wait for the DNS resolution. Avoid this behavior if you want to be able to disable a server immediately after its DNS record expires. This behavior can be used in includes. - dns
Prefresh GetProperty Rules Builder Rules V20230105Behavior Dns Prefresh - Allows edge servers to refresh your origin's DNS record independently from end-user requests. The
type A
DNS record refreshes before the origin's DNS record expires. This behavior is for internal usage only. This behavior can be used in includes. - downgrade
Protocol GetProperty Rules Builder Rules V20230105Behavior Downgrade Protocol - Serve static objects to the end-user client over HTTPS, but fetch them from the origin via HTTP. This behavior cannot be used in includes.
- download
Complete GetMarker Property Rules Builder Rules V20230105Behavior Download Complete Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes. - download
Notification GetProperty Rules Builder Rules V20230105Behavior Download Notification - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior allows requests to theOTA Updates API
for a list of completed downloads to individual vehicles. This behavior cannot be used in includes. - downstream
Cache GetProperty Rules Builder Rules V20230105Behavior Downstream Cache - Specify the caching instructions the edge server sends to the end user's client or client proxies. By default, the cache's duration is whichever is less: the remaining lifetime of the edge cache, or what the origin's header specifies. If the origin is set to
no-store
orbypass-cache
, edge servers sendcache-busting
headers downstream to prevent downstream caching. This behavior can be used in includes. - dynamic
Throughtput GetOptimization Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization - Enables
quick retry
, which detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. By default, connections under 5 mbps trigger this behavior. When the transfer rate drops below this rate during a connection attempt, quick retry is enabled and a different forward connection path is used. Contact Akamai Professional Services to override this threshold. This behavior can be used in includes. - dynamic
Throughtput GetOptimization Override Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization Override - This overrides the default threshold of 5 Mbps that triggers the
dynamicThroughtputOptimization
behavior, which enables the quick retry feature. Quick retry detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. This behavior is for internal usage only. This behavior can be used in includes. - dynamic
Web GetContent Property Rules Builder Rules V20230105Behavior Dynamic Web Content - In conjunction with the
subCustomer
behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers usingAkamai Cloud Embed
. This behavior can be used in includes. - ecms
Bulk GetUpload Property Rules Builder Rules V20230105Behavior Ecms Bulk Upload - Uploads a ZIP archive with objects to an existing data set. The target data set stores objects as key-value pairs. The path to an object in the ZIP archive is a key, and the content of an object is a value. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - ecms
Database GetProperty Rules Builder Rules V20230105Behavior Ecms Database - Edge Connect Message Store is available for
Internet of Things: Edge Connect
users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB.ecmsDatabase
specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure theecmsDataset
behavior to specify a default data set for requests. This behavior cannot be used in includes. - ecms
Dataset GetProperty Rules Builder Rules V20230105Behavior Ecms Dataset - Specifies a default data set for requests to this property unless indicated otherwise in the URL. To access objects in this data set, you can skip the data set name in the URLs. To access objects in a different data set within a database, pass the data set name in the header, query parameter, or a regular expression pattern matching a URL segment. You can also configure the
ecmsDatabase
behavior to specify a default database for requests. This behavior cannot be used in includes. - ecms
Object GetKey Property Rules Builder Rules V20230105Behavior Ecms Object Key - Defines a regular expression to match object keys in custom URLs and to access objects in a data set. You can point custom URLs to access proper values in the target data set. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - edge
Connect GetProperty Rules Builder Rules V20230105Behavior Edge Connect - Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
- edge
Load GetBalancing Advanced Property Rules Builder Rules V20230105Behavior Edge Load Balancing Advanced - This behavior implements customized Edge Load Balancing features. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior cannot be used in includes.
- edge
Load GetBalancing Data Center Property Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center - The Edge Load Balancing module allows you to specify groups of data centers that implement load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- edge
Load GetBalancing Origin Property Rules Builder Rules V20230105Behavior Edge Load Balancing Origin - The Edge Load Balancing module allows you to implement groups of data centers featuring load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Edge Origin Authorization - Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
- edge
Redirector GetProperty Rules Builder Rules V20230105Behavior Edge Redirector - This behavior enables the
Edge Redirector Cloudlet
application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control the Edge Redirector withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - edge
Scape GetProperty Rules Builder Rules V20230105Behavior Edge Scape EdgeScape
allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a specialX-Akamai-Edgescape
header to the origin server encoding relevant details about the end-user client as key-value pairs. This behavior can be used in includes.- edge
Side GetIncludes Property Rules Builder Rules V20230105Behavior Edge Side Includes - Allows edge servers to process edge side include (ESI) code to generate dynamic content. To apply this behavior, you need to match on a
contentType
,path
, orfilename
. Since this behavior requires more parsing time, you should not apply it to pages that lack ESI code, or to any non-HTML content. This behavior can be used in includes. - edge
Worker GetProperty Rules Builder Rules V20230105Behavior Edge Worker EdgeWorkers
are JavaScript applications that allow you to manipulate your web traffic on edge servers outside of Property Manager behaviors, and deployed independently from your configuration's logic. This behavior applies an EdgeWorker to a set of edge requests. This behavior cannot be used in includes.- enhanced
Akamai GetProtocol Property Rules Builder Rules V20230105Behavior Enhanced Akamai Protocol - Enables the Enhanced Akamai Protocol, a suite of advanced routing and transport optimizations that increase your website's performance and reliability. It is only available to specific applications, and requires a special routing from edge to origin. This behavior can be used in includes.
- enhanced
Proxy GetDetection Property Rules Builder Rules V20230105Behavior Enhanced Proxy Detection - Enhanced Proxy Detection (EPD) leverages the GeoGuard service provided by GeoComply to add proxy detection and location spoofing protection. It identifies requests for your content that have been redirected from an unwanted source through a proxy. You can then allow, deny, or redirect these requests. This behavior can be used in includes.
- epd
Forward GetHeader Enrichment Property Rules Builder Rules V20230105Behavior Epd Forward Header Enrichment - This behavior identifies unwanted requests from an anonymous proxy. This and the
enhancedProxyDetection
behavior work together and need to be included either in the same rule, or in the default one. This behavior can be used in includes. - fail
Action GetProperty Rules Builder Rules V20230105Behavior Fail Action - Specifies how to respond when the origin is not available: by serving stale content, by serving an error page, or by redirecting. To apply this behavior, you should match on an
originTimeout
ormatchResponseCode
. This behavior can be used in includes. - failover
Bot GetManager Feature Compatibility Property Rules Builder Rules V20230105Behavior Failover Bot Manager Feature Compatibility - Ensures that functionality such as challenge authentication and reset protocol work with a failover product property you use to create an alternate hostname. Apply it to any properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- fast
Invalidate GetProperty Rules Builder Rules V20230105Behavior Fast Invalidate - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- first
Party GetMarketing Property Rules Builder Rules V20230105Behavior First Party Marketing - Enables the Cloud Marketing Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketingPlus
behavior, which integrates better with both MediaMath and its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - first
Party GetMarketing Plus Property Rules Builder Rules V20230105Behavior First Party Marketing Plus - Enables the Cloud Marketing Plus Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketing
behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - forward
Rewrite GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite - The Forward Rewrite Cloudlet allows you to conditionally modify the forward path in edge content without affecting the URL that displays in the user's address bar. If Cloudlets are available on your contract, choose
Your services
>Edge logic Cloudlets
to control how this feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - front
End GetOptimization Property Rules Builder Rules V20230105Behavior Front End Optimization - This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
- g2oheader
Get
Property Rules Builder Rules V20230105Behavior G2oheader - The
signature header authentication
(g2o) security feature provides header-based verification of outgoing origin requests. Edge servers encrypt request data in a pre-defined header, which the origin uses to verify that the edge server processed the request. This behavior configures the request data, header names, encryption algorithm, and shared secret to use for verification. This behavior can be used in includes. - global
Request GetNumber Property Rules Builder Rules V20230105Behavior Global Request Number - Generates a unique identifier for each request on the Akamai edge network, for use in logging and debugging. GRN identifiers follow the same format as Akamai's error reference strings, for example:
0.05313217.1567801841.1457a3
. You can use the Edge Diagnostics API'sTranslate error string
operation to get low-level details about any request. This behavior can be used in includes. - graphql
Caching GetProperty Rules Builder Rules V20230105Behavior Graphql Caching - This behavior configures how to cache GraphQL-based API traffic. Enable
caching
for your GraphQL API traffic, along withallowPost
to cache POST responses. To configure REST API traffic, use therapid
behavior. This behavior can be used in includes. - gzip
Response GetProperty Rules Builder Rules V20230105Behavior Gzip Response - Apply
gzip
compression to speed transfer time. This behavior applies best to text-based content such as HTML, CSS, and JavaScript, especially once files exceed about 10KB. Do not apply it to already compressed image formats, or to small files that would add more time to uncompress. To apply this behavior, you should match oncontentType
or the content'scacheability
. This behavior can be used in includes. - hd
Data GetAdvanced Property Rules Builder Rules V20230105Behavior Hd Data Advanced - This behavior specifies Akamai XML metadata that can only be configured on your behalf by Akamai Professional Services. Unlike the
advanced
behavior, this may apply a different set of overriding metadata that executes in a post-processing phase. This behavior is for internal usage only. This behavior can be used in includes. - health
Detection GetProperty Rules Builder Rules V20230105Behavior Health Detection - Monitors the health of your origin server by tracking unsuccessful attempts to contact it. Use this behavior to keep end users from having to wait several seconds before a forwarded request times out, or to reduce requests on the origin server when it is unavailable. This behavior can be used in includes.
- hsaf
Eip GetBinding Property Rules Builder Rules V20230105Behavior Hsaf Eip Binding - Edge IP Binding works with a limited set of static IP addresses to distribute your content, which can be limiting in large footprint environments. This behavior sets Hash Serial and Forward (HSAF) for Edge IP Binding to deal with larger footprints. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- http2
Get
Property Rules Builder Rules V20230105Behavior Http2 - Enables the HTTP/2 protocol, which reduces latency and improves efficiency. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
for guidance. This behavior cannot be used in includes. - http3
Get
Property Rules Builder Rules V20230105Behavior Http3 - This enables the HTTP/3 protocol that uses QUIC. The behavior allows for improved performance and faster connection setup. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
and theProperty Manager documentation
for guidance. This behavior cannot be used in includes. - http
Strict GetTransport Security Property Rules Builder Rules V20230105Behavior Http Strict Transport Security - Applies HTTP Strict Transport Security (HSTS), disallowing insecure HTTP traffic. Apply this to hostnames managed with Standard TLS or Enhanced TLS certificates. This behavior cannot be used in includes.
- http
To GetHttps Upgrade Property Rules Builder Rules V20230105Behavior Http To Https Upgrade - Upgrades an HTTP edge request to HTTPS for the remainder of the request flow. Enable this behavior only if your origin supports HTTPS, and if your
origin
behavior is configured withoriginCertsToHonor
to verify SSL certificates. This behavior can be used in includes. - im
Override GetProperty Rules Builder Rules V20230105Behavior Im Override - This specifies common query parameters that affect how
imageManager
transforms images, potentially overriding policy, width, format, or density request parameters. This also allows you to assign the value of one of the property'srule tree variables
to one of Image and Video Manager's own policy variables. This behavior can be used in includes. - image
And GetVideo Manager Property Rules Builder Rules V20230105Behavior Image And Video Manager - This behavior can be used in includes.
- image
Manager GetProperty Rules Builder Rules V20230105Behavior Image Manager - Optimizes images' size or file type for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching images using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. Once you apply Image and Video Manager to traffic, you can add theadvancedImMatch
to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes. - image
Manager GetVideo Property Rules Builder Rules V20230105Behavior Image Manager Video - Optimizes videos managed by Image and Video Manager for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching videos using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. This behavior can be used in includes. - include
Get
Property Rules Builder Rules V20230105Behavior Include - Includes let you reuse chunks of a property configuration that you can manage separately from the rest of the property rule tree. This behavior cannot be used in includes.
- input
Validation GetProperty Rules Builder Rules V20230105Behavior Input Validation - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- instant
Get
Property Rules Builder Rules V20230105Behavior Instant - The Instant feature allows you to prefetch content to the edge cache by adding link relation attributes to markup. For example: This behavior can be used in includes.
- instant
Config GetProperty Rules Builder Rules V20230105Behavior Instant Config - Multi-Domain Configuration, also known as
InstantConfig
, allows you to apply property settings to all incoming hostnames based on a DNS lookup, without explicitly listing them among the property's hostnames. This behavior cannot be used in includes. - large
File GetOptimization Property Rules Builder Rules V20230105Behavior Large File Optimization - The
Large File Optimization
(LFO) feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and you should apply it to anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files, and enable theuseVersioning
option while enforcing your own filename versioning policy. Make sure you meet all therequirements and best practices
for the LFO delivery. This behavior can be used in includes. - large
File GetOptimization Advanced Property Rules Builder Rules V20230105Behavior Large File Optimization Advanced - The
Large File Optimization
feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and it's recommended for anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files. Note that it is best to useNetStorage
for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes. - limit
Bit GetRate Property Rules Builder Rules V20230105Behavior Limit Bit Rate - Control the rate at which content serves out to end users, optionally varying the speed depending on the file size or elapsed download time. Each bit rate specified in the
bitrateTable
array corresponds to athresholdTable
entry that activates it. You can use this behavior to prevent media downloads from progressing faster than they are viewed, for example, or to differentiate various tiers of end-user experience. To apply this behavior, you should match on acontentType
,path
, orfilename
. This behavior can be used in includes. - log
Custom GetProperty Rules Builder Rules V20230105Behavior Log Custom - Logs custom details from the origin response in the
Log Delivery Service
report. This behavior can be used in includes. - m
Pulse GetProperty Rules Builder Rules V20230105Behavior MPulse mPulse
provides high-level performance analytics and predictive recommendations based on real end user data. See themPulse Quick Start
to set up mPulse on your website. This behavior cannot be used in includes.- manifest
Personalization GetProperty Rules Builder Rules V20230105Behavior Manifest Personalization - Allows customers who use the Adaptive Media Delivery product to enhance content based on the capabilities of each end user's device. This behavior configures a
manifest
for both HLS Live and on-demand streaming. For more information, seeAdaptive Media Delivery
. This behavior can be used in includes. - manifest
Rerouting GetProperty Rules Builder Rules V20230105Behavior Manifest Rerouting - This behavior works with
adScalerCircuitBreaker
. It delegates parts of the media delivery workflow, like ad insertion, to other technology partners. Akamai reroutes manifest file requests to partner platforms for processing prior to being delivered. Rerouting simplifies the workflow and improves the media streaming experience. This behavior cannot be used in includes. - manual
Server GetPush Property Rules Builder Rules V20230105Behavior Manual Server Push - With the
http2
behavior enabled, this loads a specified set of objects into the client browser's cache. To apply this behavior, you should match on apath
orfilename
. This behavior cannot be used in includes. - media
Acceleration GetProperty Rules Builder Rules V20230105Behavior Media Acceleration - Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
- media
Acceleration GetQuic Optout Property Rules Builder Rules V20230105Behavior Media Acceleration Quic Optout - When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
- media
Client GetProperty Rules Builder Rules V20230105Behavior Media Client - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- media
File GetRetrieval Optimization Property Rules Builder Rules V20230105Behavior Media File Retrieval Optimization - Media File Retrieval Optimization (MFRO) speeds the delivery of large media files by relying on caches of partial objects. You should use it for files larger than 100 MB. It's required for files larger than 1.8 GB, and works best with
NetStorage
. To apply this behavior, you should match on afileExtension
. This behavior can be used in includes. - media
Origin GetFailover Property Rules Builder Rules V20230105Behavior Media Origin Failover - Specifies how edge servers respond when the origin is unresponsive, or suffers from server or content errors. You can specify how many times to retry, switch to a backup origin hostname, or configure a redirect. This behavior can be used in includes.
- metadata
Caching GetProperty Rules Builder Rules V20230105Behavior Metadata Caching - This behavior reduces time spent waiting for the initial response, also known as time to first byte, during peak traffic events. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- mobile
Sdk GetPerformance Property Rules Builder Rules V20230105Behavior Mobile Sdk Performance - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- modify
Incoming GetRequest Header Property Rules Builder Rules V20230105Behavior Modify Incoming Request Header - Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
- modify
Incoming GetResponse Header Property Rules Builder Rules V20230105Behavior Modify Incoming Response Header - Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
- modify
Outgoing GetRequest Header Property Rules Builder Rules V20230105Behavior Modify Outgoing Request Header - Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
- modify
Outgoing GetResponse Header Property Rules Builder Rules V20230105Behavior Modify Outgoing Response Header - Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
- modify
Via GetHeader Property Rules Builder Rules V20230105Behavior Modify Via Header - Removes or renames the HTTP
Via
headers used to inform the server of proxies through which the request was sent to the origin. This behavior can be used in includes. - origin
Get
Property Rules Builder Rules V20230105Behavior Origin - Specify the hostname and settings used to contact the origin once service begins. You can use your own origin,
NetStorage
, an Edge Load Balancing origin, or a SaaS dynamic origin. This behavior can be used in includes. - origin
Characteristics GetProperty Rules Builder Rules V20230105Behavior Origin Characteristics - Specifies characteristics of the origin. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior cannot be used in includes.
- origin
Characteristics GetWsd Property Rules Builder Rules V20230105Behavior Origin Characteristics Wsd - Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
- origin
Failure GetRecovery Method Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Method - Origin Failover requires that you set up a separate rule containing origin failure recovery methods. You also need to set up the Origin Failure Recovery Policy behavior in a separate rule with a desired match criteria, and select the desired failover method. You can do this using Property Manager. Learn more about this process in
Adaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryPolicy
member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes. - origin
Failure GetRecovery Policy Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Policy - Configures how to detect an origin failure, in which case the
originFailureRecoveryMethod
behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process inAdaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryMethod
member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes. - origin
Ip GetAcl Property Rules Builder Rules V20230105Behavior Origin Ip Acl - Origin IP Access Control List limits the traffic to your origin. It only allows requests from specific edge servers that are configured as part of a supernet defined by CIDR blocks. This behavior can be used in includes.
- persistent
Client GetConnection Property Rules Builder Rules V20230105Behavior Persistent Client Connection - This behavior activates
persistent connections
between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with thepersistentConnection
behavior, which configures persistent connections for the entire journey from origin to edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - persistent
Connection GetProperty Rules Builder Rules V20230105Behavior Persistent Connection - This behavior enables more efficient
persistent connections
from origin to edge server to client. Compare with thepersistentClientConnection
behavior, which customizes persistent connections from edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - personally
Identifiable GetInformation Property Rules Builder Rules V20230105Behavior Personally Identifiable Information - Marks content covered by the current rule as sensitive
personally identifiable information
that needs to be treated as secure and private. That includes anything involving personal information: name, social security number, date and place of birth, mother's maiden name, biometric data, or any other data linked to an individual. If you attempt to save a property with such a rule that also caches or logs sensitive content, the added behavior results in a validation error. This behavior cannot be used in includes. - phased
Release GetProperty Rules Builder Rules V20230105Behavior Phased Release - The Phased Release Cloudlet provides gradual and granular traffic management to an alternate origin in near real time. Use the
Cloudlets API
or the Cloudlets Policy Manager application withinControl Center
to set up your Cloudlets policies. This behavior cannot be used in includes. - preconnect
Get
Property Rules Builder Rules V20230105Behavior Preconnect - With the
http2
behavior enabled, this requests a specified set of domains that relate to your property hostname, and keeps the connection open for faster loading of content from those domains. This behavior can be used in includes. - predictive
Content GetDelivery Property Rules Builder Rules V20230105Behavior Predictive Content Delivery - Improves user experience and reduces the cost of downloads by enabling mobile devices to predictively fetch and cache content from catalogs managed by Akamai servers. You can't use this feature if in the
segmentedMediaOptimization
behavior, the value forbehavior
is set toLIVE
. This behavior can be used in includes. - predictive
Prefetching GetProperty Rules Builder Rules V20230105Behavior Predictive Prefetching - This behavior potentially reduces the client's page load time by pre-caching objects based on historical data for the page, not just its current set of referenced objects. It also detects second-level dependencies, such as objects retrieved by JavaScript. This behavior can be used in includes.
- prefetch
Get
Property Rules Builder Rules V20230105Behavior Prefetch - Instructs edge servers to retrieve content linked from requested pages as they load, rather than waiting for separate requests for the linked content. This behavior applies depending on the rule's set of matching conditions. Use in conjunction with the
prefetchable
behavior, which specifies the set of objects to prefetch. This behavior can be used in includes. - prefetchable
Get
Property Rules Builder Rules V20230105Behavior Prefetchable - Allow matching objects to prefetch into the edge cache as the parent page that links to them loads, rather than waiting for a direct request. This behavior applies depending on the rule's set of matching conditions. Use
prefetch
to enable the overall behavior for parent pages that contain links to the object. To apply this behavior, you need to match on afilename
orfileExtension
. This behavior can be used in includes. - prefresh
Cache GetProperty Rules Builder Rules V20230105Behavior Prefresh Cache - Refresh cached content before its time-to-live (TTL) expires, to keep end users from having to wait for the origin to provide fresh content. This behavior can be used in includes.
- quality
Get
Property Rules Builder Rules V20230105Behavior Quality - This behavior can be used in includes.
- quic
Beta GetProperty Rules Builder Rules V20230105Behavior Quic Beta - For a share of responses, includes an
Alt-Svc
header for compatible clients to initiate subsequent sessions using the QUIC protocol. This behavior cannot be used in includes. - random
Seek GetProperty Rules Builder Rules V20230105Behavior Random Seek - Optimizes
.flv
and.mp4
files to allow random jump-point navigation. This behavior can be used in includes. - rapid
Get
Property Rules Builder Rules V20230105Behavior Rapid - The
Akamai API Gateway
allows you to configure API traffic delivered over the Akamai network. Apply this behavior to a set of API assets, then use Akamai'sAPI Endpoints API
to configure how the traffic responds. Use theAPI Keys and Traffic Management API
to control access to your APIs. This behavior cannot be used in includes. - read
Timeout GetProperty Rules Builder Rules V20230105Behavior Read Timeout - This behavior specifies how long the edge server should wait for a response from the requesting forward server after a connection has already been established. This behavior can be used in includes.
- real
Time GetReporting Property Rules Builder Rules V20230105Behavior Real Time Reporting - This enables Real-Time Reporting for Akamai
Cloud Embed
customers. The behavior can only be configured on your behalf by Akamai Professional Services. You can access real-time reports data for that base configuration withMedia Delivery Reports API
. This behavior is for internal usage only. This behavior can be used in includes. - real
User GetMonitoring Property Rules Builder Rules V20230105Behavior Real User Monitoring - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- redirect
Get
Property Rules Builder Rules V20230105Behavior Redirect - Respond to the client request with a redirect without contacting the origin. Specify the redirect as a path expression starting with a
/
character relative to the current root, or as a fully qualified URL. This behavior relies primarily ondestinationHostname
anddestinationPath
to manipulate the hostname and path independently. This behavior can be used in includes. - redirectplus
Get
Property Rules Builder Rules V20230105Behavior Redirectplus - Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as
redirect
, but allows you to usevariables
to express the redirectdestination
's component values more concisely. This behavior can be used in includes. - referer
Checking GetProperty Rules Builder Rules V20230105Behavior Referer Checking - Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
- remove
Query GetParameter Property Rules Builder Rules V20230105Behavior Remove Query Parameter - Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
- remove
Vary GetProperty Rules Builder Rules V20230105Behavior Remove Vary - By default, responses that feature a
Vary
header value of anything other thanAccept-Encoding
and a correspondingContent-Encoding: gzip
header aren't cached on edge servers.Vary
headers indicate when a URL's content varies depending on some variable, such as whichUser-Agent
requests it. This behavior simply removes theVary
header to make responses cacheable. This behavior can be used in includes. - report
Get
Property Rules Builder Rules V20230105Behavior Report - Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
- request
Control GetProperty Rules Builder Rules V20230105Behavior Request Control - The Request Control Cloudlet allows you to control access to your web content based on the incoming request's IP or geographic location. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control how the feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - request
Type GetMarker Property Rules Builder Rules V20230105Behavior Request Type Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. When using thedownloadCompleteMarker
behavior to log successful downloads, this related behavior identifies download or campaign server types in aggregated and individual reports. This behavior can be used in includes. - resource
Optimizer GetProperty Rules Builder Rules V20230105Behavior Resource Optimizer - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- resource
Optimizer GetExtended Compatibility Property Rules Builder Rules V20230105Behavior Resource Optimizer Extended Compatibility - This enhances the standard version of the
resourceOptimizer
behavior to support the compression of additional file formats and address some compatibility issues. This behavior can be used in includes. - response
Code GetProperty Rules Builder Rules V20230105Behavior Response Code - Change the existing response code. For example, if your origin sends a
301
permanent redirect, this behavior can change it on the edge to a temporary302
redirect. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Response Cookie - Set a cookie to send downstream to the client with either a fixed value or a unique stamp. This behavior can be used in includes.
- restrict
Object GetCaching Property Rules Builder Rules V20230105Behavior Restrict Object Caching - You need this behavior to deploy the Object Caching product. It disables serving HTML content and limits the maximum object size to 100MB. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- return
Cache GetStatus Property Rules Builder Rules V20230105Behavior Return Cache Status - Generates a response header with information about cache status. Among other things, this can tell you whether the response came from the Akamai cache, or from the origin. Status values report with either of these forms of syntax, depending for example on whether you're deploying traffic using
sureRoute
ortieredDistribution
: This behavior can be used in includes. - rewrite
Url GetProperty Rules Builder Rules V20230105Behavior Rewrite Url - Modifies the path of incoming requests to forward to the origin. This helps you offload URL-rewriting tasks to the edge to increase the origin server's performance, allows you to redirect links to different targets without changing markup, and hides your original directory structure. This behavior can be used in includes.
- rum
Custom GetProperty Rules Builder Rules V20230105Behavior Rum Custom - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- saas
Definitions GetProperty Rules Builder Rules V20230105Behavior Saas Definitions - Configures how the Software as a Service feature identifies
customers
,applications
, andusers
. A different set of options is available for each type of targeted request, each enabled with theaction
-suffixed option. In each case, you can usePATH
,COOKIE
,QUERY_STRING
, orHOSTNAME
components as identifiers, ordisable
the SaaS behavior for certain targets. If you rely on aHOSTNAME
, you also have the option of specifying aCNAME chain
rather than an individual hostname. The various options suffixedregex
andreplace
subsequently remove the identifier from the request. This behavior requires a siblingorigin
behavior whoseoriginType
option is set toSAAS_DYNAMIC_ORIGIN
. This behavior cannot be used in includes. - sales
Force GetCommerce Cloud Client Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Client - If you use the Salesforce Commerce Cloud platform for your origin content, this behavior allows your edge content managed by Akamai to contact directly to origin. This behavior cannot be used in includes.
- sales
Force GetCommerce Cloud Provider Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider - This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- sales
Force GetCommerce Cloud Provider Host Header Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider Host Header - Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- save
Post GetDca Processing Property Rules Builder Rules V20230105Behavior Save Post Dca Processing - Used in conjunction with the
cachePost
behavior, this behavior allows the body of POST requests to be processed through Dynamic Content Assembly. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes. - schedule
Invalidation GetProperty Rules Builder Rules V20230105Behavior Schedule Invalidation - Specifies when cached content that satisfies a rule's criteria expires, optionally at repeating intervals. In addition to periodic cache flushes, you can use this behavior to minimize potential conflicts when related objects expire at different times. This behavior can be used in includes.
- script
Management GetProperty Rules Builder Rules V20230105Behavior Script Management - Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. See
Script Management API
for more information. This behavior cannot be used in includes. - segmented
Content GetProtection Property Rules Builder Rules V20230105Behavior Segmented Content Protection - Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
- segmented
Media GetOptimization Property Rules Builder Rules V20230105Behavior Segmented Media Optimization - Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
- segmented
Media GetStreaming Prefetch Property Rules Builder Rules V20230105Behavior Segmented Media Streaming Prefetch - Prefetches HLS and DASH media stream manifest and segment files, accelerating delivery to end users. For prefetching to work, your origin media's response needs to specify
CDN-Origin-Assist-Prefetch-Path
headers with each URL to prefetch, expressed as either a relative or absolute path. This behavior can be used in includes. - set
Variable GetProperty Rules Builder Rules V20230105Behavior Set Variable - Modify a variable to insert into subsequent fields within the rule tree. Use this behavior to specify the predeclared
variableName
and determine from where to derive its new value. Based on thisvalueSource
, you can either generate the value, extract it from some part of the incoming request, assign it from another variable (including a set of built-in system variables), or directly specify its text. Optionally choose atransform
function to modify the value once. SeeSupport for variables
for more information. This behavior can be used in includes. - shutr
Get
Property Rules Builder Rules V20230105Behavior Shutr - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- simulate
Error GetCode Property Rules Builder Rules V20230105Behavior Simulate Error Code - This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- site
Shield GetProperty Rules Builder Rules V20230105Behavior Site Shield - This behavior implements the
Site Shield
feature, which helps prevent non-Akamai machines from contacting your origin. You get an email with a list of Akamai servers allowed to contact your origin, with which you establish an Access Control List on your firewall to prevent any other requests. This behavior cannot be used in includes. - standard
Tls GetMigration Property Rules Builder Rules V20230105Behavior Standard Tls Migration - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- standard
Tls GetMigration Override Property Rules Builder Rules V20230105Behavior Standard Tls Migration Override - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- strict
Header GetParsing Property Rules Builder Rules V20230105Behavior Strict Header Parsing - This behavior specifies how the edge servers should handle requests containing improperly formatted or invalid headers that don’t comply with
RFC 9110
. This behavior can be used in includes. - sub
Customer GetProperty Rules Builder Rules V20230105Behavior Sub Customer - When positioned in a property's top-level default rule, enables various
Cloud Embed
features that allow you to leverage Akamai's CDN architecture for your own subcustomers. This behavior's options allow you to use Cloud Embed to configure your subcustomers' content. Once enabled, you can use theAkamai Cloud Embed API
(ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also thedynamicWebContent
behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes. - sure
Route GetProperty Rules Builder Rules V20230105Behavior Sure Route - The
SureRoute
feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conductsraces
to identify alternative paths to use in case of a transmission failure. These races increase origin traffic slightly. This behavior cannot be used in includes. - tcp
Optimization GetProperty Rules Builder Rules V20230105Behavior Tcp Optimization - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- tea
Leaf GetProperty Rules Builder Rules V20230105Behavior Tea Leaf - Allows IBM Tealeaf Customer Experience on Cloud to record HTTPS requests and responses for Akamai-enabled properties. Recorded data becomes available in your IBM Tealeaf account. This behavior cannot be used in includes.
- tiered
Distribution GetProperty Rules Builder Rules V20230105Behavior Tiered Distribution - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This behavior cannot be used in includes. - tiered
Distribution GetAdvanced Property Rules Builder Rules V20230105Behavior Tiered Distribution Advanced - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This advanced behavior provides a wider set of options thantieredDistribution
. This behavior is for internal usage only. This behavior can be used in includes. - tiered
Distribution GetCustomization Property Rules Builder Rules V20230105Behavior Tiered Distribution Customization - With Tiered Distribution, Akamai edge servers retrieve cached content from other Akamai servers, rather than directly from the origin. This behavior sets custom Tiered Distribution maps (TD0) and migrates TD1 maps configured with
advanced features
to Cloud Wrapper. You need to enablecloudWrapper
within the same rule. This behavior is for internal usage only. This behavior can be used in includes. - timeout
Get
Property Rules Builder Rules V20230105Behavior Timeout - Sets the HTTP connect timeout. This behavior can be used in includes.
- uid
Configuration GetProperty Rules Builder Rules V20230105Behavior Uid Configuration - This behavior allows you to extract unique identifier (UID) values from live traffic, for use in OTA applications. Note that you are responsible for maintaining the security of any data that may identify individual users. This behavior cannot be used in includes.
- validate
Entity GetTag Property Rules Builder Rules V20230105Behavior Validate Entity Tag - Instructs edge servers to compare the request's
ETag
header with that of the cached object. If they differ, the edge server sends a new copy of the object. This validation occurs in addition to the default validation ofLast-Modified
andIf-Modified-Since
headers. This behavior can be used in includes. - verify
Json GetWeb Token Property Rules Builder Rules V20230105Behavior Verify Json Web Token - This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
- verify
Json GetWeb Token For Dcp Property Rules Builder Rules V20230105Behavior Verify Json Web Token For Dcp - This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing
IoT Edge Connect
, which you use thedcp
behavior to configure. You can specify the location in a request to pass a JSON web token (JWT), collections of public keys to verify the integrity of this token, and specific claims to extract from it. Use theverifyJsonWebToken
behavior for other JWT validation. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Verify Token Authorization - Verifies Auth 2.0 tokens. This behavior can be used in includes.
- virtual
Waiting GetRoom Property Rules Builder Rules V20230105Behavior Virtual Waiting Room - This behavior helps you maintain business continuity for dynamic applications in high-demand situations such as flash sales. It decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a request processing mechanism that prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control Virtual Waitig Room withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - virtual
Waiting GetRoom With Edge Workers Property Rules Builder Rules V20230105Behavior Virtual Waiting Room With Edge Workers - This behavior allows you to configure the
virtualWaitingRoom
behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes. - visitor
Prioritization GetProperty Rules Builder Rules V20230105Behavior Visitor Prioritization - The
Visitor Prioritization Cloudlet
decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - visitor
Prioritization GetFifo Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo - (BETA) The
Visitor Prioritization Cloudlet (FIFO)
decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a fair request processing mechanism, which prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization (FIFO) withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - visitor
Prioritization GetFifo Standalone Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo Standalone - This behavior cannot be used in includes.
- watermarking
Get
Property Rules Builder Rules V20230105Behavior Watermarking - Adds watermarking for each valid user's content. Content segments are delivered from different sources using a pattern unique to each user, based on a watermarking token included in each request. If your content is pirated or redistributed, you can forensically analyze the segments to extract the pattern, and identify the user who leaked the content. This behavior can be used in includes.
- web
Application GetFirewall Property Rules Builder Rules V20230105Behavior Web Application Firewall - This behavior implements a suite of security features that blocks threatening HTTP and HTTPS requests. Use it as your primary firewall, or in addition to existing security measures. Only one referenced configuration is allowed per property, so this behavior typically belongs as part of its default rule. This behavior cannot be used in includes.
- web
Sockets GetProperty Rules Builder Rules V20230105Behavior Web Sockets - The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
- webdav
Get
Property Rules Builder Rules V20230105Behavior Webdav - Web-based Distributed Authoring and Versioning (WebDAV) is a set of extensions to the HTTP protocol that allows users to collaboratively edit and manage files on remote web servers. This behavior enables WebDAV, and provides support for the following additional request methods: PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. To apply this behavior, you need to match on a
requestMethod
. This behavior can be used in includes.
- ad
Scaler GetCircuit Breaker Property Rules Builder Rules V20230105Behavior Ad Scaler Circuit Breaker - This behavior works with
manifestRerouting
to provide the scale and reliability of Akamai network while simultaneously allowing third party partners to modify the requested media content with value-added features. TheadScalerCircuitBreaker
behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object. This behavior cannot be used in includes. - adaptive
Acceleration GetProperty Rules Builder Rules V20230105Behavior Adaptive Acceleration - Adaptive Acceleration uses HTTP/2 server push functionality with Ion properties to pre-position content and improve the performance of HTML page loading based on real user monitoring (RUM) timing data. It also helps browsers to preconnect to content that’s likely needed for upcoming requests. To use this behavior, make sure you enable the
http2
behavior. Use theAdaptive Acceleration API
to report on the set of assets this feature optimizes. This behavior cannot be used in includes. - adaptive
Image GetCompression Property Rules Builder Rules V20230105Behavior Adaptive Image Compression Note: Starting from May 31, 2024, Adaptive Image Compression is no longer supported and the image compression configured through this functionality won't take place. As an alternative, we offer
Image & Video Manager
. It intelligently and automatically optimizes images and videos on the fly for every user. Reach out to your Akamai representatives for more information on this product. This behavior can be used in includes.- advanced
Get
Property Rules Builder Rules V20230105Behavior Advanced - This specifies Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- aggregated
Reporting GetProperty Rules Builder Rules V20230105Behavior Aggregated Reporting - Configure a custom report that collects traffic data. The data is based on one to four variables, such as
sum
,average
,min
, andmax
. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes. - akamaizer
Get
Property Rules Builder Rules V20230105Behavior Akamaizer - This allows you to run regular expression substitutions over web pages. To apply this behavior, you need to match on a
contentType
. Contact Akamai Professional Services for help configuring the Akamaizer. See also theakamaizerTag
behavior. This behavior is for internal usage only. This behavior can be used in includes. - akamaizer
Tag GetProperty Rules Builder Rules V20230105Behavior Akamaizer Tag - This specifies HTML tags and replacement rules for hostnames used in conjunction with the
akamaizer
behavior. Contact Akamai Professional Services for help configuring the Akamaizer. This behavior is for internal usage only. This behavior can be used in includes. - all
Http GetIn Cache Hierarchy Property Rules Builder Rules V20230105Behavior All Http In Cache Hierarchy - Allow all HTTP request methods to be used for the edge's parent servers, useful to implement features such as
Site Shield
,SureRoute
, and Tiered Distribution. (See thesiteShield
,sureRoute
, andtieredDistribution
behaviors.) This behavior can be used in includes. - allow
Cloudlets GetOrigins Property Rules Builder Rules V20230105Behavior Allow Cloudlets Origins - Allows Cloudlets Origins to determine the criteria, separately from the Property Manager, under which alternate
origin
definitions are assigned. This behavior cannot be used in includes. - allow
Delete GetProperty Rules Builder Rules V20230105Behavior Allow Delete - Allow HTTP requests using the DELETE method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any DELETE requests pass to the origin. See also the
allowOptions
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Https GetCache Key Sharing Property Rules Builder Rules V20230105Behavior Allow Https Cache Key Sharing - HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
- allow
Https GetDowngrade Property Rules Builder Rules V20230105Behavior Allow Https Downgrade - Passes HTTPS requests to origin as HTTP. This is useful when incorporating Standard TLS or Akamai's shared certificate delivery security with an origin that serves HTTP traffic. This behavior can be used in includes.
- allow
Options GetProperty Rules Builder Rules V20230105Behavior Allow Options - GET, HEAD, and OPTIONS requests are allowed by default. All other HTTP methods result in a 501 error. For full support of Cross-Origin Resource Sharing (CORS), you need to allow requests that use the OPTIONS method. If you're using the
corsSupport
behavior, do not disable OPTIONS requests. The response to an OPTIONS request is not cached, so the request always goes through the Akamai network to your origin, unless you use theconstructResponse
behavior to send responses directly from the Akamai network. See also theallowDelete
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Patch GetProperty Rules Builder Rules V20230105Behavior Allow Patch - Allow HTTP requests using the PATCH method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PATCH requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Post GetProperty Rules Builder Rules V20230105Behavior Allow Post - Allow HTTP requests using the POST method. By default, GET, HEAD, and OPTIONS requests are allowed, and POST requests are denied with 403 error. All other methods result in a 501 error. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPut
behaviors. This behavior can be used in includes. - allow
Put GetProperty Rules Builder Rules V20230105Behavior Allow Put - Allow HTTP requests using the PUT method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PUT requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPost
behaviors. This behavior can be used in includes. - allow
Transfer GetEncoding Property Rules Builder Rules V20230105Behavior Allow Transfer Encoding - Controls whether to allow or deny Chunked Transfer Encoding (CTE) requests to pass to your origin. If your origin supports CTE, you should enable this behavior. This behavior also protects against a known issue when pairing
http2
andwebdav
behaviors within the same rule tree, in which case it's required. This behavior can be used in includes. - alt
Svc GetHeader Property Rules Builder Rules V20230105Behavior Alt Svc Header - Sets the maximum age value for the Alternative Services (
Alt-Svc
) header. This behavior can be used in includes. - api
Prioritization GetProperty Rules Builder Rules V20230105Behavior Api Prioritization - Enables the API Prioritization Cloudlet, which maintains continuity in user experience by serving an alternate static response when load is too high. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. Use this feature serve static API content, such as fallback JSON data. To serve non-API HTML content, use thevisitorPrioritization
behavior. This behavior can be used in includes. - application
Load GetBalancer Property Rules Builder Rules V20230105Behavior Application Load Balancer - Enables the Application Load Balancer Cloudlet, which automates load balancing based on configurable criteria. To configure this behavior, use either the Cloudlets Policy Manager or the
Cloudlets API
to set up a policy. This behavior cannot be used in includes. - audience
Segmentation GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation - Allows you to divide your users into different segments based on a persistent cookie. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. This behavior cannot be used in includes. - auto
Domain GetValidation Property Rules Builder Rules V20230105Behavior Auto Domain Validation - This behavior allows standard TLS domain validated certificates to renew automatically. Apply it after using the
Certificate Provisioning System
to request a certificate for a hostname. To provision certificates programmatically, see theCertificate Provisioning System API
. This behavior can be used in includes. - base
Directory GetProperty Rules Builder Rules V20230105Behavior Base Directory - Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
- boss
Beaconing GetProperty Rules Builder Rules V20230105Behavior Boss Beaconing - Triggers diagnostic data beacons for use with BOSS, Akamai's monitoring and diagnostics system. This behavior is for internal usage only. This behavior can be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Breadcrumbs - Provides per-HTTP transaction visibility into a request for content, regardless of how deep the request goes into the Akamai platform. The
Akamai-Request-BC
response header includes various data, such as network health and the location in the Akamai network used to serve content, which simplifies log review for troubleshooting. This behavior can be used in includes. - break
Connection GetProperty Rules Builder Rules V20230105Behavior Break Connection - This behavior simulates an origin connection problem, typically to test an accompanying
failAction
policy. This behavior can be used in includes. - brotli
Get
Property Rules Builder Rules V20230105Behavior Brotli - Accesses Brotli-compressed assets from your origin and caches them on edge servers. This doesn't compress resources within the content delivery network in real time. You need to set up Brotli compression separately on your origin. If a requesting client doesn't support Brotli, edge servers deliver non-Brotli resources. This behavior can be used in includes.
- cache
Error GetProperty Rules Builder Rules V20230105Behavior Cache Error - Caches the origin's error responses to decrease server load. Applies for 10 seconds by default to the following HTTP codes:
204
,305
,404
,405
,501
,502
,503
,504
, and505
. This behavior can be used in includes. - cache
Id GetProperty Rules Builder Rules V20230105Behavior Cache Id - Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
- cache
Key GetIgnore Case Property Rules Builder Rules V20230105Behavior Cache Key Ignore Case - By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that
File.html
andfile.html
use separate cache keys. Enabling this behavior forces URL components whose case varies to resolve to the same cache key. Enable this behavior if your origin server is already case-insensitive, such as those based on Microsoft IIS. This behavior can be used in includes. - cache
Key GetQuery Params Property Rules Builder Rules V20230105Behavior Cache Key Query Params - By default, cache keys are formed as URLs with full query strings. This behavior allows you to consolidate cached objects based on specified sets of query parameters. This behavior can be used in includes.
- cache
Key GetRewrite Property Rules Builder Rules V20230105Behavior Cache Key Rewrite - This behavior rewrites a default cache key's path. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- cache
Post GetProperty Rules Builder Rules V20230105Behavior Cache Post - By default, POST requests are passed to the origin. This behavior overrides the default, and allows you to cache POST responses. This behavior can be used in includes.
- cache
Redirect GetProperty Rules Builder Rules V20230105Behavior Cache Redirect - Controls the caching of HTTP 302 and 307 temporary redirects. By default, Akamai edge servers don't cache them. Enabling this behavior instructs edge servers to allow these redirects to be cached the same as HTTP 200 responses. This behavior can be used in includes.
- cache
Tag GetProperty Rules Builder Rules V20230105Behavior Cache Tag - This adds a cache tag to the requested object. With cache tags, you can flexibly fast purge tagged segments of your cached content. You can either define these tags with an
Edge-Cache-Tag
header at the origin server level, or use this behavior to directly add a cache tag to the object as the edge server caches it. ThecacheTag
behavior can only take a single value, including a variable. If you want to specify more tags for an object, add a few instances of this behavior to your configuration. This behavior can be used in includes. - cache
Tag GetVisible Property Rules Builder Rules V20230105Behavior Cache Tag Visible - Cache tags are comma-separated string values you define within an
Edge-Cache-Tag
header. You can use them to flexibly fast purge tagged segments of your cached content. You can either define these headers at the origin server level, or use themodifyOutgoingResponseHeader
behavior to configure them at the edge. Apply this behavior to confirm you're deploying the intended set of cache tags to your content. This behavior can be used in includes. - caching
Get
Property Rules Builder Rules V20230105Behavior Caching - Control content caching on edge servers: whether or not to cache, whether to honor the origin's caching headers, and for how long to cache. Note that any
NO_STORE
orBYPASS_CACHE
HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see theLearn about caching
section in the guide. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Central Authorization - Forward client requests to the origin server for authorization, along with optional
Set-Cookie
headers, useful when you need to maintain tight access control. The edge server forwards anIf-Modified-Since
header, to which the origin needs to respond with a304
(Not-Modified) HTTP status when authorization succeeds. If so, the edge server responds to the client with the cached object, since it does not need to be re-acquired from the origin. This behavior can be used in includes. - chase
Redirects GetProperty Rules Builder Rules V20230105Behavior Chase Redirects - Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
- client
Characteristics GetProperty Rules Builder Rules V20230105Behavior Client Characteristics - Specifies characteristics of the client ecosystem. Akamai uses this information to optimize your metadata configuration, which may result in better end-user performance. This behavior can be used in includes.
- cloud
Interconnects GetProperty Rules Builder Rules V20230105Behavior Cloud Interconnects - Cloud Interconnects forwards traffic from edge servers to your cloud origin through Private Network Interconnects (PNIs), helping to reduce the egress costs at the origin. Supports origins hosted by Google Cloud Provider (GCP). This behavior cannot be used in includes.
- cloud
Wrapper GetProperty Rules Builder Rules V20230105Behavior Cloud Wrapper Cloud Wrapper
maximizes origin offload for large libraries of video, game, and software downloads by optimizing data caches in regions nearest to your origin. You can't use this behavior in conjunction withsureRoute
ortieredDistribution
. This behavior cannot be used in includes.- cloud
Wrapper GetAdvanced Property Rules Builder Rules V20230105Behavior Cloud Wrapper Advanced - Your account representative uses this behavior to implement a customized failover configuration on your behalf. Use Cloud Wrapper Advanced with an enabled
cloudWrapper
behavior in the same rule. This behavior is for internal usage only. This behavior cannot be used in includes. - conditional
Origin GetProperty Rules Builder Rules V20230105Behavior Conditional Origin - This behavior cannot be used in includes.
- construct
Response GetProperty Rules Builder Rules V20230105Behavior Construct Response - This behavior constructs an HTTP response, complete with HTTP status code and body, to serve from the edge independently of your origin. For example, you might want to send a customized response if the URL doesn't point to an object on the origin server, or if the end user is not authorized to view the requested content. You can use it with all request methods you allow for your property, including POST. For more details, see the
allowOptions
,allowPatch
,allowPost
,allowPut
, andallowDelete
behaviors. This behavior can be used in includes. - content
Characteristics GetProperty Rules Builder Rules V20230105Behavior Content Characteristics - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetAmd Property Rules Builder Rules V20230105Behavior Content Characteristics Amd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetDd Property Rules Builder Rules V20230105Behavior Content Characteristics Dd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetWsd Large File Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Large File - Specifies characteristics of the delivered content, specifically targeted to delivering large files. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetWsd Live Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Live - Specifies characteristics of the delivered content, specifically targeted to delivering live video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics GetWsd Vod Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Vod - Specifies characteristics of the delivered content, specifically targeted to delivering on-demand video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Pre GetPosition Property Rules Builder Rules V20230105Behavior Content Pre Position - Content Preposition. This behavior can be used in includes.
- content
Targeting GetProtection Property Rules Builder Rules V20230105Behavior Content Targeting Protection - Content Targeting is based on
EdgeScape
, Akamai's location-based access control system. You can use it to allow or deny access to a set of geographic regions or IP addresses. This behavior can be used in includes. - cors
Support GetProperty Rules Builder Rules V20230105Behavior Cors Support - Cross-origin resource sharing (CORS) allows web pages in one domain to access restricted resources from your domain. Specify external origin hostnames, methods, and headers that you want to accept via HTTP response headers. Full support of CORS requires allowing requests that use the OPTIONS method. See
allowOptions
. This behavior can be used in includes. - cp
Code GetProperty Rules Builder Rules V20230105Behavior Cp Code - Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. You receive an initial CP code when purchasing Akamai, and you can run the
Create a new CP code
operation to generate more. This behavior applies any valid CP code, either as required as a default at the top of the rule tree, or subsequently to override the default. For a CP code to be valid, it needs to be assigned the same contract and product as the property, and the group needs access to it. For available values, run theList CP codes
operation. This behavior can be used in includes. - custom
Behavior GetProperty Rules Builder Rules V20230105Behavior Custom Behavior - Allows you to insert a customized XML metadata behavior into any property's rule tree. Talk to your Akamai representative to implement the customized behavior. Once it's ready, run PAPI's
List custom behaviors
operation, then apply the relevantbehaviorId
value from the response within the currentcustomBehavior
. SeeCustom behaviors and overrides
for guidance on custom metadata behaviors. This behavior can be used in includes. - datastream
Get
Property Rules Builder Rules V20230105Behavior Datastream - The
DataStream
reporting service provides real-time logs on application activity, including aggregated metrics on complete request and response cycles and origin response times. Apply this behavior to report on this set of traffic. Use theDataStream API
to aggregate the data. This behavior cannot be used in includes. - dcp
Get
Property Rules Builder Rules V20230105Behavior Dcp - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (TheIoT Edge Connect API
allows programmatic access.) This behavior allows you to select previously reserved namespaces and set the protocols for users to publish and receive messages within these namespaces. Use theverifyJsonWebTokenForDcp
behavior to control access. This behavior cannot be used in includes. - dcp
Auth GetHmac Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Hmac Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then generates a hash value based on the selected algorithm, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth GetRegex Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Regex Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then transforms the string based on a regular expression search pattern, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth GetSubstring Transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Substring Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then extracts a substring, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth GetVariable Extractor Property Rules Builder Rules V20230105Behavior Dcp Auth Variable Extractor - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. When enabled, this behavior allows end users to authenticate their requests with valid x509 client certificates. Either a client identifier or access authorization groups are required to make the request valid. This behavior cannot be used in includes. - dcp
Default GetAuthz Groups Property Rules Builder Rules V20230105Behavior Dcp Default Authz Groups - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior defines a set of default authorization groups to add to each request the property configuration controls. These groups have access regardless of the authentication method you use, either JWT using theverifyJsonWebTokenForDcp
behavior, or mutual authentication using thedcpAuthVariableExtractor
behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes. - dcp
Dev GetRelations Property Rules Builder Rules V20230105Behavior Dcp Dev Relations - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior allows Akamai-external clients to use developer test accounts in a shared environment. In conjunction withverifyJsonWebTokenForDcp
, this behavior allows you to use your own JWTs in your requests, or those generated by Akamai. It lets you either enable the default JWT server for your test configuration by setting the authentication endpoint to a default path, or specify custom settings for your JWT server and the authentication endpoint. This behavior cannot be used in includes. - dcp
Real GetTime Auth Property Rules Builder Rules V20230105Behavior Dcp Real Time Auth - INTERNAL ONLY: The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior lets you configure the real time authentication to edge servers. This behavior is for internal usage only. This behavior cannot be used in includes. - delivery
Receipt GetProperty Rules Builder Rules V20230105Behavior Delivery Receipt - A static behavior that's required when specifying the Cloud Monitor module's (
edgeConnect
behavior. You can only apply this behavior if the property is marked as secure. SeeSecure property requirements
for guidance. This behavior can be used in includes. - deny
Access GetProperty Rules Builder Rules V20230105Behavior Deny Access - Assuming a condition in the rule matches, this denies access to the requested content. For example, a
userLocation
match paired with this behavior would deny requests from a specified part of the world. This behavior can be used in includes. - deny
Direct GetFailover Access Property Rules Builder Rules V20230105Behavior Deny Direct Failover Access - A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- device
Characteristic GetCache Id Property Rules Builder Rules V20230105Behavior Device Characteristic Cache Id - By default, source URLs serve as cache IDs on edge servers. Electronic Data Capture allows you to specify an additional set of device characteristics to generate separate cache keys. Use this in conjunction with the
deviceCharacteristicHeader
behavior. This behavior can be used in includes. - device
Characteristic GetHeader Property Rules Builder Rules V20230105Behavior Device Characteristic Header - Sends selected information about requesting devices to the origin server, in the form of an
X-Akamai-Device-Characteristics
HTTP header. Use in conjunction with thedeviceCharacteristicCacheId
behavior. This behavior can be used in includes. - dns
Async GetRefresh Property Rules Builder Rules V20230105Behavior Dns Async Refresh - Allow an edge server to use an expired DNS record when forwarding a request to your origin. The
type A
DNS record refreshesafter
content is served to the end user, so there is no wait for the DNS resolution. Avoid this behavior if you want to be able to disable a server immediately after its DNS record expires. This behavior can be used in includes. - dns
Prefresh GetProperty Rules Builder Rules V20230105Behavior Dns Prefresh - Allows edge servers to refresh your origin's DNS record independently from end-user requests. The
type A
DNS record refreshes before the origin's DNS record expires. This behavior is for internal usage only. This behavior can be used in includes. - downgrade
Protocol GetProperty Rules Builder Rules V20230105Behavior Downgrade Protocol - Serve static objects to the end-user client over HTTPS, but fetch them from the origin via HTTP. This behavior cannot be used in includes.
- download
Complete GetMarker Property Rules Builder Rules V20230105Behavior Download Complete Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes. - download
Notification GetProperty Rules Builder Rules V20230105Behavior Download Notification - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior allows requests to theOTA Updates API
for a list of completed downloads to individual vehicles. This behavior cannot be used in includes. - downstream
Cache GetProperty Rules Builder Rules V20230105Behavior Downstream Cache - Specify the caching instructions the edge server sends to the end user's client or client proxies. By default, the cache's duration is whichever is less: the remaining lifetime of the edge cache, or what the origin's header specifies. If the origin is set to
no-store
orbypass-cache
, edge servers sendcache-busting
headers downstream to prevent downstream caching. This behavior can be used in includes. - dynamic
Throughtput GetOptimization Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization - Enables
quick retry
, which detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. By default, connections under 5 mbps trigger this behavior. When the transfer rate drops below this rate during a connection attempt, quick retry is enabled and a different forward connection path is used. Contact Akamai Professional Services to override this threshold. This behavior can be used in includes. - dynamic
Throughtput GetOptimization Override Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization Override - This overrides the default threshold of 5 Mbps that triggers the
dynamicThroughtputOptimization
behavior, which enables the quick retry feature. Quick retry detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. This behavior is for internal usage only. This behavior can be used in includes. - dynamic
Web GetContent Property Rules Builder Rules V20230105Behavior Dynamic Web Content - In conjunction with the
subCustomer
behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers usingAkamai Cloud Embed
. This behavior can be used in includes. - ecms
Bulk GetUpload Property Rules Builder Rules V20230105Behavior Ecms Bulk Upload - Uploads a ZIP archive with objects to an existing data set. The target data set stores objects as key-value pairs. The path to an object in the ZIP archive is a key, and the content of an object is a value. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - ecms
Database GetProperty Rules Builder Rules V20230105Behavior Ecms Database - Edge Connect Message Store is available for
Internet of Things: Edge Connect
users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB.ecmsDatabase
specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure theecmsDataset
behavior to specify a default data set for requests. This behavior cannot be used in includes. - ecms
Dataset GetProperty Rules Builder Rules V20230105Behavior Ecms Dataset - Specifies a default data set for requests to this property unless indicated otherwise in the URL. To access objects in this data set, you can skip the data set name in the URLs. To access objects in a different data set within a database, pass the data set name in the header, query parameter, or a regular expression pattern matching a URL segment. You can also configure the
ecmsDatabase
behavior to specify a default database for requests. This behavior cannot be used in includes. - ecms
Object GetKey Property Rules Builder Rules V20230105Behavior Ecms Object Key - Defines a regular expression to match object keys in custom URLs and to access objects in a data set. You can point custom URLs to access proper values in the target data set. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - edge
Connect GetProperty Rules Builder Rules V20230105Behavior Edge Connect - Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
- edge
Load GetBalancing Advanced Property Rules Builder Rules V20230105Behavior Edge Load Balancing Advanced - This behavior implements customized Edge Load Balancing features. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior cannot be used in includes.
- edge
Load GetBalancing Data Center Property Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center - The Edge Load Balancing module allows you to specify groups of data centers that implement load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- edge
Load GetBalancing Origin Property Rules Builder Rules V20230105Behavior Edge Load Balancing Origin - The Edge Load Balancing module allows you to implement groups of data centers featuring load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Edge Origin Authorization - Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
- edge
Redirector GetProperty Rules Builder Rules V20230105Behavior Edge Redirector - This behavior enables the
Edge Redirector Cloudlet
application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control the Edge Redirector withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - edge
Scape GetProperty Rules Builder Rules V20230105Behavior Edge Scape EdgeScape
allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a specialX-Akamai-Edgescape
header to the origin server encoding relevant details about the end-user client as key-value pairs. This behavior can be used in includes.- edge
Side GetIncludes Property Rules Builder Rules V20230105Behavior Edge Side Includes - Allows edge servers to process edge side include (ESI) code to generate dynamic content. To apply this behavior, you need to match on a
contentType
,path
, orfilename
. Since this behavior requires more parsing time, you should not apply it to pages that lack ESI code, or to any non-HTML content. This behavior can be used in includes. - edge
Worker GetProperty Rules Builder Rules V20230105Behavior Edge Worker EdgeWorkers
are JavaScript applications that allow you to manipulate your web traffic on edge servers outside of Property Manager behaviors, and deployed independently from your configuration's logic. This behavior applies an EdgeWorker to a set of edge requests. This behavior cannot be used in includes.- enhanced
Akamai GetProtocol Property Rules Builder Rules V20230105Behavior Enhanced Akamai Protocol - Enables the Enhanced Akamai Protocol, a suite of advanced routing and transport optimizations that increase your website's performance and reliability. It is only available to specific applications, and requires a special routing from edge to origin. This behavior can be used in includes.
- enhanced
Proxy GetDetection Property Rules Builder Rules V20230105Behavior Enhanced Proxy Detection - Enhanced Proxy Detection (EPD) leverages the GeoGuard service provided by GeoComply to add proxy detection and location spoofing protection. It identifies requests for your content that have been redirected from an unwanted source through a proxy. You can then allow, deny, or redirect these requests. This behavior can be used in includes.
- epd
Forward GetHeader Enrichment Property Rules Builder Rules V20230105Behavior Epd Forward Header Enrichment - This behavior identifies unwanted requests from an anonymous proxy. This and the
enhancedProxyDetection
behavior work together and need to be included either in the same rule, or in the default one. This behavior can be used in includes. - fail
Action GetProperty Rules Builder Rules V20230105Behavior Fail Action - Specifies how to respond when the origin is not available: by serving stale content, by serving an error page, or by redirecting. To apply this behavior, you should match on an
originTimeout
ormatchResponseCode
. This behavior can be used in includes. - failover
Bot GetManager Feature Compatibility Property Rules Builder Rules V20230105Behavior Failover Bot Manager Feature Compatibility - Ensures that functionality such as challenge authentication and reset protocol work with a failover product property you use to create an alternate hostname. Apply it to any properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- fast
Invalidate GetProperty Rules Builder Rules V20230105Behavior Fast Invalidate - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- first
Party GetMarketing Property Rules Builder Rules V20230105Behavior First Party Marketing - Enables the Cloud Marketing Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketingPlus
behavior, which integrates better with both MediaMath and its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - first
Party GetMarketing Plus Property Rules Builder Rules V20230105Behavior First Party Marketing Plus - Enables the Cloud Marketing Plus Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketing
behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - forward
Rewrite GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite - The Forward Rewrite Cloudlet allows you to conditionally modify the forward path in edge content without affecting the URL that displays in the user's address bar. If Cloudlets are available on your contract, choose
Your services
>Edge logic Cloudlets
to control how this feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - front
End GetOptimization Property Rules Builder Rules V20230105Behavior Front End Optimization - This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
- g2oheader
Get
Property Rules Builder Rules V20230105Behavior G2oheader - The
signature header authentication
(g2o) security feature provides header-based verification of outgoing origin requests. Edge servers encrypt request data in a pre-defined header, which the origin uses to verify that the edge server processed the request. This behavior configures the request data, header names, encryption algorithm, and shared secret to use for verification. This behavior can be used in includes. - global
Request GetNumber Property Rules Builder Rules V20230105Behavior Global Request Number - Generates a unique identifier for each request on the Akamai edge network, for use in logging and debugging. GRN identifiers follow the same format as Akamai's error reference strings, for example:
0.05313217.1567801841.1457a3
. You can use the Edge Diagnostics API'sTranslate error string
operation to get low-level details about any request. This behavior can be used in includes. - graphql
Caching GetProperty Rules Builder Rules V20230105Behavior Graphql Caching - This behavior configures how to cache GraphQL-based API traffic. Enable
caching
for your GraphQL API traffic, along withallowPost
to cache POST responses. To configure REST API traffic, use therapid
behavior. This behavior can be used in includes. - gzip
Response GetProperty Rules Builder Rules V20230105Behavior Gzip Response - Apply
gzip
compression to speed transfer time. This behavior applies best to text-based content such as HTML, CSS, and JavaScript, especially once files exceed about 10KB. Do not apply it to already compressed image formats, or to small files that would add more time to uncompress. To apply this behavior, you should match oncontentType
or the content'scacheability
. This behavior can be used in includes. - hd
Data GetAdvanced Property Rules Builder Rules V20230105Behavior Hd Data Advanced - This behavior specifies Akamai XML metadata that can only be configured on your behalf by Akamai Professional Services. Unlike the
advanced
behavior, this may apply a different set of overriding metadata that executes in a post-processing phase. This behavior is for internal usage only. This behavior can be used in includes. - health
Detection GetProperty Rules Builder Rules V20230105Behavior Health Detection - Monitors the health of your origin server by tracking unsuccessful attempts to contact it. Use this behavior to keep end users from having to wait several seconds before a forwarded request times out, or to reduce requests on the origin server when it is unavailable. This behavior can be used in includes.
- hsaf
Eip GetBinding Property Rules Builder Rules V20230105Behavior Hsaf Eip Binding - Edge IP Binding works with a limited set of static IP addresses to distribute your content, which can be limiting in large footprint environments. This behavior sets Hash Serial and Forward (HSAF) for Edge IP Binding to deal with larger footprints. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- http2
Get
Property Rules Builder Rules V20230105Behavior Http2 - Enables the HTTP/2 protocol, which reduces latency and improves efficiency. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
for guidance. This behavior cannot be used in includes. - http3
Get
Property Rules Builder Rules V20230105Behavior Http3 - This enables the HTTP/3 protocol that uses QUIC. The behavior allows for improved performance and faster connection setup. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
and theProperty Manager documentation
for guidance. This behavior cannot be used in includes. - http
Strict GetTransport Security Property Rules Builder Rules V20230105Behavior Http Strict Transport Security - Applies HTTP Strict Transport Security (HSTS), disallowing insecure HTTP traffic. Apply this to hostnames managed with Standard TLS or Enhanced TLS certificates. This behavior cannot be used in includes.
- http
To GetHttps Upgrade Property Rules Builder Rules V20230105Behavior Http To Https Upgrade - Upgrades an HTTP edge request to HTTPS for the remainder of the request flow. Enable this behavior only if your origin supports HTTPS, and if your
origin
behavior is configured withoriginCertsToHonor
to verify SSL certificates. This behavior can be used in includes. - im
Override GetProperty Rules Builder Rules V20230105Behavior Im Override - This specifies common query parameters that affect how
imageManager
transforms images, potentially overriding policy, width, format, or density request parameters. This also allows you to assign the value of one of the property'srule tree variables
to one of Image and Video Manager's own policy variables. This behavior can be used in includes. - image
And GetVideo Manager Property Rules Builder Rules V20230105Behavior Image And Video Manager - This behavior can be used in includes.
- image
Manager GetProperty Rules Builder Rules V20230105Behavior Image Manager - Optimizes images' size or file type for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching images using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. Once you apply Image and Video Manager to traffic, you can add theadvancedImMatch
to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes. - image
Manager GetVideo Property Rules Builder Rules V20230105Behavior Image Manager Video - Optimizes videos managed by Image and Video Manager for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching videos using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. This behavior can be used in includes. - include
Get
Property Rules Builder Rules V20230105Behavior Include - Includes let you reuse chunks of a property configuration that you can manage separately from the rest of the property rule tree. This behavior cannot be used in includes.
- input
Validation GetProperty Rules Builder Rules V20230105Behavior Input Validation - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- instant
Get
Property Rules Builder Rules V20230105Behavior Instant - The Instant feature allows you to prefetch content to the edge cache by adding link relation attributes to markup. For example: This behavior can be used in includes.
- instant
Config GetProperty Rules Builder Rules V20230105Behavior Instant Config - Multi-Domain Configuration, also known as
InstantConfig
, allows you to apply property settings to all incoming hostnames based on a DNS lookup, without explicitly listing them among the property's hostnames. This behavior cannot be used in includes. - large
File GetOptimization Property Rules Builder Rules V20230105Behavior Large File Optimization - The
Large File Optimization
(LFO) feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and you should apply it to anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files, and enable theuseVersioning
option while enforcing your own filename versioning policy. Make sure you meet all therequirements and best practices
for the LFO delivery. This behavior can be used in includes. - large
File GetOptimization Advanced Property Rules Builder Rules V20230105Behavior Large File Optimization Advanced - The
Large File Optimization
feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and it's recommended for anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files. Note that it is best to useNetStorage
for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes. - limit
Bit GetRate Property Rules Builder Rules V20230105Behavior Limit Bit Rate - Control the rate at which content serves out to end users, optionally varying the speed depending on the file size or elapsed download time. Each bit rate specified in the
bitrateTable
array corresponds to athresholdTable
entry that activates it. You can use this behavior to prevent media downloads from progressing faster than they are viewed, for example, or to differentiate various tiers of end-user experience. To apply this behavior, you should match on acontentType
,path
, orfilename
. This behavior can be used in includes. - log
Custom GetProperty Rules Builder Rules V20230105Behavior Log Custom - Logs custom details from the origin response in the
Log Delivery Service
report. This behavior can be used in includes. - m
Pulse GetProperty Rules Builder Rules V20230105Behavior MPulse mPulse
provides high-level performance analytics and predictive recommendations based on real end user data. See themPulse Quick Start
to set up mPulse on your website. This behavior cannot be used in includes.- manifest
Personalization GetProperty Rules Builder Rules V20230105Behavior Manifest Personalization - Allows customers who use the Adaptive Media Delivery product to enhance content based on the capabilities of each end user's device. This behavior configures a
manifest
for both HLS Live and on-demand streaming. For more information, seeAdaptive Media Delivery
. This behavior can be used in includes. - manifest
Rerouting GetProperty Rules Builder Rules V20230105Behavior Manifest Rerouting - This behavior works with
adScalerCircuitBreaker
. It delegates parts of the media delivery workflow, like ad insertion, to other technology partners. Akamai reroutes manifest file requests to partner platforms for processing prior to being delivered. Rerouting simplifies the workflow and improves the media streaming experience. This behavior cannot be used in includes. - manual
Server GetPush Property Rules Builder Rules V20230105Behavior Manual Server Push - With the
http2
behavior enabled, this loads a specified set of objects into the client browser's cache. To apply this behavior, you should match on apath
orfilename
. This behavior cannot be used in includes. - media
Acceleration GetProperty Rules Builder Rules V20230105Behavior Media Acceleration - Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
- media
Acceleration GetQuic Optout Property Rules Builder Rules V20230105Behavior Media Acceleration Quic Optout - When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
- media
Client GetProperty Rules Builder Rules V20230105Behavior Media Client - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- media
File GetRetrieval Optimization Property Rules Builder Rules V20230105Behavior Media File Retrieval Optimization - Media File Retrieval Optimization (MFRO) speeds the delivery of large media files by relying on caches of partial objects. You should use it for files larger than 100 MB. It's required for files larger than 1.8 GB, and works best with
NetStorage
. To apply this behavior, you should match on afileExtension
. This behavior can be used in includes. - media
Origin GetFailover Property Rules Builder Rules V20230105Behavior Media Origin Failover - Specifies how edge servers respond when the origin is unresponsive, or suffers from server or content errors. You can specify how many times to retry, switch to a backup origin hostname, or configure a redirect. This behavior can be used in includes.
- metadata
Caching GetProperty Rules Builder Rules V20230105Behavior Metadata Caching - This behavior reduces time spent waiting for the initial response, also known as time to first byte, during peak traffic events. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- mobile
Sdk GetPerformance Property Rules Builder Rules V20230105Behavior Mobile Sdk Performance - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- modify
Incoming GetRequest Header Property Rules Builder Rules V20230105Behavior Modify Incoming Request Header - Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
- modify
Incoming GetResponse Header Property Rules Builder Rules V20230105Behavior Modify Incoming Response Header - Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
- modify
Outgoing GetRequest Header Property Rules Builder Rules V20230105Behavior Modify Outgoing Request Header - Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
- modify
Outgoing GetResponse Header Property Rules Builder Rules V20230105Behavior Modify Outgoing Response Header - Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
- modify
Via GetHeader Property Rules Builder Rules V20230105Behavior Modify Via Header - Removes or renames the HTTP
Via
headers used to inform the server of proxies through which the request was sent to the origin. This behavior can be used in includes. - origin
Get
Property Rules Builder Rules V20230105Behavior Origin - Specify the hostname and settings used to contact the origin once service begins. You can use your own origin,
NetStorage
, an Edge Load Balancing origin, or a SaaS dynamic origin. This behavior can be used in includes. - origin
Characteristics GetProperty Rules Builder Rules V20230105Behavior Origin Characteristics - Specifies characteristics of the origin. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior cannot be used in includes.
- origin
Characteristics GetWsd Property Rules Builder Rules V20230105Behavior Origin Characteristics Wsd - Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
- origin
Failure GetRecovery Method Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Method - Origin Failover requires that you set up a separate rule containing origin failure recovery methods. You also need to set up the Origin Failure Recovery Policy behavior in a separate rule with a desired match criteria, and select the desired failover method. You can do this using Property Manager. Learn more about this process in
Adaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryPolicy
member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes. - origin
Failure GetRecovery Policy Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Policy - Configures how to detect an origin failure, in which case the
originFailureRecoveryMethod
behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process inAdaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryMethod
member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes. - origin
Ip GetAcl Property Rules Builder Rules V20230105Behavior Origin Ip Acl - Origin IP Access Control List limits the traffic to your origin. It only allows requests from specific edge servers that are configured as part of a supernet defined by CIDR blocks. This behavior can be used in includes.
- persistent
Client GetConnection Property Rules Builder Rules V20230105Behavior Persistent Client Connection - This behavior activates
persistent connections
between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with thepersistentConnection
behavior, which configures persistent connections for the entire journey from origin to edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - persistent
Connection GetProperty Rules Builder Rules V20230105Behavior Persistent Connection - This behavior enables more efficient
persistent connections
from origin to edge server to client. Compare with thepersistentClientConnection
behavior, which customizes persistent connections from edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - personally
Identifiable GetInformation Property Rules Builder Rules V20230105Behavior Personally Identifiable Information - Marks content covered by the current rule as sensitive
personally identifiable information
that needs to be treated as secure and private. That includes anything involving personal information: name, social security number, date and place of birth, mother's maiden name, biometric data, or any other data linked to an individual. If you attempt to save a property with such a rule that also caches or logs sensitive content, the added behavior results in a validation error. This behavior cannot be used in includes. - phased
Release GetProperty Rules Builder Rules V20230105Behavior Phased Release - The Phased Release Cloudlet provides gradual and granular traffic management to an alternate origin in near real time. Use the
Cloudlets API
or the Cloudlets Policy Manager application withinControl Center
to set up your Cloudlets policies. This behavior cannot be used in includes. - preconnect
Get
Property Rules Builder Rules V20230105Behavior Preconnect - With the
http2
behavior enabled, this requests a specified set of domains that relate to your property hostname, and keeps the connection open for faster loading of content from those domains. This behavior can be used in includes. - predictive
Content GetDelivery Property Rules Builder Rules V20230105Behavior Predictive Content Delivery - Improves user experience and reduces the cost of downloads by enabling mobile devices to predictively fetch and cache content from catalogs managed by Akamai servers. You can't use this feature if in the
segmentedMediaOptimization
behavior, the value forbehavior
is set toLIVE
. This behavior can be used in includes. - predictive
Prefetching GetProperty Rules Builder Rules V20230105Behavior Predictive Prefetching - This behavior potentially reduces the client's page load time by pre-caching objects based on historical data for the page, not just its current set of referenced objects. It also detects second-level dependencies, such as objects retrieved by JavaScript. This behavior can be used in includes.
- prefetch
Get
Property Rules Builder Rules V20230105Behavior Prefetch - Instructs edge servers to retrieve content linked from requested pages as they load, rather than waiting for separate requests for the linked content. This behavior applies depending on the rule's set of matching conditions. Use in conjunction with the
prefetchable
behavior, which specifies the set of objects to prefetch. This behavior can be used in includes. - prefetchable
Get
Property Rules Builder Rules V20230105Behavior Prefetchable - Allow matching objects to prefetch into the edge cache as the parent page that links to them loads, rather than waiting for a direct request. This behavior applies depending on the rule's set of matching conditions. Use
prefetch
to enable the overall behavior for parent pages that contain links to the object. To apply this behavior, you need to match on afilename
orfileExtension
. This behavior can be used in includes. - prefresh
Cache GetProperty Rules Builder Rules V20230105Behavior Prefresh Cache - Refresh cached content before its time-to-live (TTL) expires, to keep end users from having to wait for the origin to provide fresh content. This behavior can be used in includes.
- quality
Get
Property Rules Builder Rules V20230105Behavior Quality - This behavior can be used in includes.
- quic
Beta GetProperty Rules Builder Rules V20230105Behavior Quic Beta - For a share of responses, includes an
Alt-Svc
header for compatible clients to initiate subsequent sessions using the QUIC protocol. This behavior cannot be used in includes. - random
Seek GetProperty Rules Builder Rules V20230105Behavior Random Seek - Optimizes
.flv
and.mp4
files to allow random jump-point navigation. This behavior can be used in includes. - rapid
Get
Property Rules Builder Rules V20230105Behavior Rapid - The
Akamai API Gateway
allows you to configure API traffic delivered over the Akamai network. Apply this behavior to a set of API assets, then use Akamai'sAPI Endpoints API
to configure how the traffic responds. Use theAPI Keys and Traffic Management API
to control access to your APIs. This behavior cannot be used in includes. - read
Timeout GetProperty Rules Builder Rules V20230105Behavior Read Timeout - This behavior specifies how long the edge server should wait for a response from the requesting forward server after a connection has already been established. This behavior can be used in includes.
- real
Time GetReporting Property Rules Builder Rules V20230105Behavior Real Time Reporting - This enables Real-Time Reporting for Akamai
Cloud Embed
customers. The behavior can only be configured on your behalf by Akamai Professional Services. You can access real-time reports data for that base configuration withMedia Delivery Reports API
. This behavior is for internal usage only. This behavior can be used in includes. - real
User GetMonitoring Property Rules Builder Rules V20230105Behavior Real User Monitoring - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- redirect
Get
Property Rules Builder Rules V20230105Behavior Redirect - Respond to the client request with a redirect without contacting the origin. Specify the redirect as a path expression starting with a
/
character relative to the current root, or as a fully qualified URL. This behavior relies primarily ondestinationHostname
anddestinationPath
to manipulate the hostname and path independently. This behavior can be used in includes. - redirectplus
Get
Property Rules Builder Rules V20230105Behavior Redirectplus - Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as
redirect
, but allows you to usevariables
to express the redirectdestination
's component values more concisely. This behavior can be used in includes. - referer
Checking GetProperty Rules Builder Rules V20230105Behavior Referer Checking - Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
- remove
Query GetParameter Property Rules Builder Rules V20230105Behavior Remove Query Parameter - Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
- remove
Vary GetProperty Rules Builder Rules V20230105Behavior Remove Vary - By default, responses that feature a
Vary
header value of anything other thanAccept-Encoding
and a correspondingContent-Encoding: gzip
header aren't cached on edge servers.Vary
headers indicate when a URL's content varies depending on some variable, such as whichUser-Agent
requests it. This behavior simply removes theVary
header to make responses cacheable. This behavior can be used in includes. - report
Get
Property Rules Builder Rules V20230105Behavior Report - Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
- request
Control GetProperty Rules Builder Rules V20230105Behavior Request Control - The Request Control Cloudlet allows you to control access to your web content based on the incoming request's IP or geographic location. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control how the feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - request
Type GetMarker Property Rules Builder Rules V20230105Behavior Request Type Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. When using thedownloadCompleteMarker
behavior to log successful downloads, this related behavior identifies download or campaign server types in aggregated and individual reports. This behavior can be used in includes. - resource
Optimizer GetProperty Rules Builder Rules V20230105Behavior Resource Optimizer - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- resource
Optimizer GetExtended Compatibility Property Rules Builder Rules V20230105Behavior Resource Optimizer Extended Compatibility - This enhances the standard version of the
resourceOptimizer
behavior to support the compression of additional file formats and address some compatibility issues. This behavior can be used in includes. - response
Code GetProperty Rules Builder Rules V20230105Behavior Response Code - Change the existing response code. For example, if your origin sends a
301
permanent redirect, this behavior can change it on the edge to a temporary302
redirect. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Response Cookie - Set a cookie to send downstream to the client with either a fixed value or a unique stamp. This behavior can be used in includes.
- restrict
Object GetCaching Property Rules Builder Rules V20230105Behavior Restrict Object Caching - You need this behavior to deploy the Object Caching product. It disables serving HTML content and limits the maximum object size to 100MB. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- return
Cache GetStatus Property Rules Builder Rules V20230105Behavior Return Cache Status - Generates a response header with information about cache status. Among other things, this can tell you whether the response came from the Akamai cache, or from the origin. Status values report with either of these forms of syntax, depending for example on whether you're deploying traffic using
sureRoute
ortieredDistribution
: This behavior can be used in includes. - rewrite
Url GetProperty Rules Builder Rules V20230105Behavior Rewrite Url - Modifies the path of incoming requests to forward to the origin. This helps you offload URL-rewriting tasks to the edge to increase the origin server's performance, allows you to redirect links to different targets without changing markup, and hides your original directory structure. This behavior can be used in includes.
- rum
Custom GetProperty Rules Builder Rules V20230105Behavior Rum Custom - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- saas
Definitions GetProperty Rules Builder Rules V20230105Behavior Saas Definitions - Configures how the Software as a Service feature identifies
customers
,applications
, andusers
. A different set of options is available for each type of targeted request, each enabled with theaction
-suffixed option. In each case, you can usePATH
,COOKIE
,QUERY_STRING
, orHOSTNAME
components as identifiers, ordisable
the SaaS behavior for certain targets. If you rely on aHOSTNAME
, you also have the option of specifying aCNAME chain
rather than an individual hostname. The various options suffixedregex
andreplace
subsequently remove the identifier from the request. This behavior requires a siblingorigin
behavior whoseoriginType
option is set toSAAS_DYNAMIC_ORIGIN
. This behavior cannot be used in includes. - sales
Force GetCommerce Cloud Client Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Client - If you use the Salesforce Commerce Cloud platform for your origin content, this behavior allows your edge content managed by Akamai to contact directly to origin. This behavior cannot be used in includes.
- sales
Force GetCommerce Cloud Provider Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider - This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- sales
Force GetCommerce Cloud Provider Host Header Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider Host Header - Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- save
Post GetDca Processing Property Rules Builder Rules V20230105Behavior Save Post Dca Processing - Used in conjunction with the
cachePost
behavior, this behavior allows the body of POST requests to be processed through Dynamic Content Assembly. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes. - schedule
Invalidation GetProperty Rules Builder Rules V20230105Behavior Schedule Invalidation - Specifies when cached content that satisfies a rule's criteria expires, optionally at repeating intervals. In addition to periodic cache flushes, you can use this behavior to minimize potential conflicts when related objects expire at different times. This behavior can be used in includes.
- script
Management GetProperty Rules Builder Rules V20230105Behavior Script Management - Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. See
Script Management API
for more information. This behavior cannot be used in includes. - segmented
Content GetProtection Property Rules Builder Rules V20230105Behavior Segmented Content Protection - Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
- segmented
Media GetOptimization Property Rules Builder Rules V20230105Behavior Segmented Media Optimization - Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
- segmented
Media GetStreaming Prefetch Property Rules Builder Rules V20230105Behavior Segmented Media Streaming Prefetch - Prefetches HLS and DASH media stream manifest and segment files, accelerating delivery to end users. For prefetching to work, your origin media's response needs to specify
CDN-Origin-Assist-Prefetch-Path
headers with each URL to prefetch, expressed as either a relative or absolute path. This behavior can be used in includes. - set
Variable GetProperty Rules Builder Rules V20230105Behavior Set Variable - Modify a variable to insert into subsequent fields within the rule tree. Use this behavior to specify the predeclared
variableName
and determine from where to derive its new value. Based on thisvalueSource
, you can either generate the value, extract it from some part of the incoming request, assign it from another variable (including a set of built-in system variables), or directly specify its text. Optionally choose atransform
function to modify the value once. SeeSupport for variables
for more information. This behavior can be used in includes. - shutr
Get
Property Rules Builder Rules V20230105Behavior Shutr - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- simulate
Error GetCode Property Rules Builder Rules V20230105Behavior Simulate Error Code - This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- site
Shield GetProperty Rules Builder Rules V20230105Behavior Site Shield - This behavior implements the
Site Shield
feature, which helps prevent non-Akamai machines from contacting your origin. You get an email with a list of Akamai servers allowed to contact your origin, with which you establish an Access Control List on your firewall to prevent any other requests. This behavior cannot be used in includes. - standard
Tls GetMigration Property Rules Builder Rules V20230105Behavior Standard Tls Migration - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- standard
Tls GetMigration Override Property Rules Builder Rules V20230105Behavior Standard Tls Migration Override - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- strict
Header GetParsing Property Rules Builder Rules V20230105Behavior Strict Header Parsing - This behavior specifies how the edge servers should handle requests containing improperly formatted or invalid headers that don’t comply with
RFC 9110
. This behavior can be used in includes. - sub
Customer GetProperty Rules Builder Rules V20230105Behavior Sub Customer - When positioned in a property's top-level default rule, enables various
Cloud Embed
features that allow you to leverage Akamai's CDN architecture for your own subcustomers. This behavior's options allow you to use Cloud Embed to configure your subcustomers' content. Once enabled, you can use theAkamai Cloud Embed API
(ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also thedynamicWebContent
behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes. - sure
Route GetProperty Rules Builder Rules V20230105Behavior Sure Route - The
SureRoute
feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conductsraces
to identify alternative paths to use in case of a transmission failure. These races increase origin traffic slightly. This behavior cannot be used in includes. - tcp
Optimization GetProperty Rules Builder Rules V20230105Behavior Tcp Optimization - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- tea
Leaf GetProperty Rules Builder Rules V20230105Behavior Tea Leaf - Allows IBM Tealeaf Customer Experience on Cloud to record HTTPS requests and responses for Akamai-enabled properties. Recorded data becomes available in your IBM Tealeaf account. This behavior cannot be used in includes.
- tiered
Distribution GetProperty Rules Builder Rules V20230105Behavior Tiered Distribution - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This behavior cannot be used in includes. - tiered
Distribution GetAdvanced Property Rules Builder Rules V20230105Behavior Tiered Distribution Advanced - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This advanced behavior provides a wider set of options thantieredDistribution
. This behavior is for internal usage only. This behavior can be used in includes. - tiered
Distribution GetCustomization Property Rules Builder Rules V20230105Behavior Tiered Distribution Customization - With Tiered Distribution, Akamai edge servers retrieve cached content from other Akamai servers, rather than directly from the origin. This behavior sets custom Tiered Distribution maps (TD0) and migrates TD1 maps configured with
advanced features
to Cloud Wrapper. You need to enablecloudWrapper
within the same rule. This behavior is for internal usage only. This behavior can be used in includes. - timeout
Get
Property Rules Builder Rules V20230105Behavior Timeout - Sets the HTTP connect timeout. This behavior can be used in includes.
- uid
Configuration GetProperty Rules Builder Rules V20230105Behavior Uid Configuration - This behavior allows you to extract unique identifier (UID) values from live traffic, for use in OTA applications. Note that you are responsible for maintaining the security of any data that may identify individual users. This behavior cannot be used in includes.
- validate
Entity GetTag Property Rules Builder Rules V20230105Behavior Validate Entity Tag - Instructs edge servers to compare the request's
ETag
header with that of the cached object. If they differ, the edge server sends a new copy of the object. This validation occurs in addition to the default validation ofLast-Modified
andIf-Modified-Since
headers. This behavior can be used in includes. - verify
Json GetWeb Token Property Rules Builder Rules V20230105Behavior Verify Json Web Token - This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
- verify
Json GetWeb Token For Dcp Property Rules Builder Rules V20230105Behavior Verify Json Web Token For Dcp - This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing
IoT Edge Connect
, which you use thedcp
behavior to configure. You can specify the location in a request to pass a JSON web token (JWT), collections of public keys to verify the integrity of this token, and specific claims to extract from it. Use theverifyJsonWebToken
behavior for other JWT validation. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Verify Token Authorization - Verifies Auth 2.0 tokens. This behavior can be used in includes.
- virtual
Waiting GetRoom Property Rules Builder Rules V20230105Behavior Virtual Waiting Room - This behavior helps you maintain business continuity for dynamic applications in high-demand situations such as flash sales. It decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a request processing mechanism that prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control Virtual Waitig Room withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - virtual
Waiting GetRoom With Edge Workers Property Rules Builder Rules V20230105Behavior Virtual Waiting Room With Edge Workers - This behavior allows you to configure the
virtualWaitingRoom
behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes. - visitor
Prioritization GetProperty Rules Builder Rules V20230105Behavior Visitor Prioritization - The
Visitor Prioritization Cloudlet
decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - visitor
Prioritization GetFifo Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo - (BETA) The
Visitor Prioritization Cloudlet (FIFO)
decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a fair request processing mechanism, which prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization (FIFO) withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - visitor
Prioritization GetFifo Standalone Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo Standalone - This behavior cannot be used in includes.
- watermarking
Get
Property Rules Builder Rules V20230105Behavior Watermarking - Adds watermarking for each valid user's content. Content segments are delivered from different sources using a pattern unique to each user, based on a watermarking token included in each request. If your content is pirated or redistributed, you can forensically analyze the segments to extract the pattern, and identify the user who leaked the content. This behavior can be used in includes.
- web
Application GetFirewall Property Rules Builder Rules V20230105Behavior Web Application Firewall - This behavior implements a suite of security features that blocks threatening HTTP and HTTPS requests. Use it as your primary firewall, or in addition to existing security measures. Only one referenced configuration is allowed per property, so this behavior typically belongs as part of its default rule. This behavior cannot be used in includes.
- web
Sockets GetProperty Rules Builder Rules V20230105Behavior Web Sockets - The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
- webdav
Get
Property Rules Builder Rules V20230105Behavior Webdav - Web-based Distributed Authoring and Versioning (WebDAV) is a set of extensions to the HTTP protocol that allows users to collaboratively edit and manage files on remote web servers. This behavior enables WebDAV, and provides support for the following additional request methods: PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. To apply this behavior, you need to match on a
requestMethod
. This behavior can be used in includes.
- ad_
scaler_ Getcircuit_ breaker Property Rules Builder Rules V20230105Behavior Ad Scaler Circuit Breaker - This behavior works with
manifestRerouting
to provide the scale and reliability of Akamai network while simultaneously allowing third party partners to modify the requested media content with value-added features. TheadScalerCircuitBreaker
behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object. This behavior cannot be used in includes. - adaptive_
acceleration GetProperty Rules Builder Rules V20230105Behavior Adaptive Acceleration - Adaptive Acceleration uses HTTP/2 server push functionality with Ion properties to pre-position content and improve the performance of HTML page loading based on real user monitoring (RUM) timing data. It also helps browsers to preconnect to content that’s likely needed for upcoming requests. To use this behavior, make sure you enable the
http2
behavior. Use theAdaptive Acceleration API
to report on the set of assets this feature optimizes. This behavior cannot be used in includes. - adaptive_
image_ Getcompression Property Rules Builder Rules V20230105Behavior Adaptive Image Compression Note: Starting from May 31, 2024, Adaptive Image Compression is no longer supported and the image compression configured through this functionality won't take place. As an alternative, we offer
Image & Video Manager
. It intelligently and automatically optimizes images and videos on the fly for every user. Reach out to your Akamai representatives for more information on this product. This behavior can be used in includes.- advanced
Get
Property Rules Builder Rules V20230105Behavior Advanced - This specifies Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- aggregated_
reporting GetProperty Rules Builder Rules V20230105Behavior Aggregated Reporting - Configure a custom report that collects traffic data. The data is based on one to four variables, such as
sum
,average
,min
, andmax
. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes. - akamaizer
Get
Property Rules Builder Rules V20230105Behavior Akamaizer - This allows you to run regular expression substitutions over web pages. To apply this behavior, you need to match on a
contentType
. Contact Akamai Professional Services for help configuring the Akamaizer. See also theakamaizerTag
behavior. This behavior is for internal usage only. This behavior can be used in includes. - akamaizer_
tag GetProperty Rules Builder Rules V20230105Behavior Akamaizer Tag - This specifies HTML tags and replacement rules for hostnames used in conjunction with the
akamaizer
behavior. Contact Akamai Professional Services for help configuring the Akamaizer. This behavior is for internal usage only. This behavior can be used in includes. - all_
http_ Getin_ cache_ hierarchy Property Rules Builder Rules V20230105Behavior All Http In Cache Hierarchy - Allow all HTTP request methods to be used for the edge's parent servers, useful to implement features such as
Site Shield
,SureRoute
, and Tiered Distribution. (See thesiteShield
,sureRoute
, andtieredDistribution
behaviors.) This behavior can be used in includes. - allow_
cloudlets_ Getorigins Property Rules Builder Rules V20230105Behavior Allow Cloudlets Origins - Allows Cloudlets Origins to determine the criteria, separately from the Property Manager, under which alternate
origin
definitions are assigned. This behavior cannot be used in includes. - allow_
delete GetProperty Rules Builder Rules V20230105Behavior Allow Delete - Allow HTTP requests using the DELETE method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any DELETE requests pass to the origin. See also the
allowOptions
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow_
https_ Getcache_ key_ sharing Property Rules Builder Rules V20230105Behavior Allow Https Cache Key Sharing - HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
- allow_
https_ Getdowngrade Property Rules Builder Rules V20230105Behavior Allow Https Downgrade - Passes HTTPS requests to origin as HTTP. This is useful when incorporating Standard TLS or Akamai's shared certificate delivery security with an origin that serves HTTP traffic. This behavior can be used in includes.
- allow_
options GetProperty Rules Builder Rules V20230105Behavior Allow Options - GET, HEAD, and OPTIONS requests are allowed by default. All other HTTP methods result in a 501 error. For full support of Cross-Origin Resource Sharing (CORS), you need to allow requests that use the OPTIONS method. If you're using the
corsSupport
behavior, do not disable OPTIONS requests. The response to an OPTIONS request is not cached, so the request always goes through the Akamai network to your origin, unless you use theconstructResponse
behavior to send responses directly from the Akamai network. See also theallowDelete
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow_
patch GetProperty Rules Builder Rules V20230105Behavior Allow Patch - Allow HTTP requests using the PATCH method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PATCH requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow_
post GetProperty Rules Builder Rules V20230105Behavior Allow Post - Allow HTTP requests using the POST method. By default, GET, HEAD, and OPTIONS requests are allowed, and POST requests are denied with 403 error. All other methods result in a 501 error. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPut
behaviors. This behavior can be used in includes. - allow_
put GetProperty Rules Builder Rules V20230105Behavior Allow Put - Allow HTTP requests using the PUT method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PUT requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPost
behaviors. This behavior can be used in includes. - allow_
transfer_ Getencoding Property Rules Builder Rules V20230105Behavior Allow Transfer Encoding - Controls whether to allow or deny Chunked Transfer Encoding (CTE) requests to pass to your origin. If your origin supports CTE, you should enable this behavior. This behavior also protects against a known issue when pairing
http2
andwebdav
behaviors within the same rule tree, in which case it's required. This behavior can be used in includes. - alt_
svc_ Getheader Property Rules Builder Rules V20230105Behavior Alt Svc Header - Sets the maximum age value for the Alternative Services (
Alt-Svc
) header. This behavior can be used in includes. - api_
prioritization GetProperty Rules Builder Rules V20230105Behavior Api Prioritization - Enables the API Prioritization Cloudlet, which maintains continuity in user experience by serving an alternate static response when load is too high. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. Use this feature serve static API content, such as fallback JSON data. To serve non-API HTML content, use thevisitorPrioritization
behavior. This behavior can be used in includes. - application_
load_ Getbalancer Property Rules Builder Rules V20230105Behavior Application Load Balancer - Enables the Application Load Balancer Cloudlet, which automates load balancing based on configurable criteria. To configure this behavior, use either the Cloudlets Policy Manager or the
Cloudlets API
to set up a policy. This behavior cannot be used in includes. - audience_
segmentation GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation - Allows you to divide your users into different segments based on a persistent cookie. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. This behavior cannot be used in includes. - auto_
domain_ Getvalidation Property Rules Builder Rules V20230105Behavior Auto Domain Validation - This behavior allows standard TLS domain validated certificates to renew automatically. Apply it after using the
Certificate Provisioning System
to request a certificate for a hostname. To provision certificates programmatically, see theCertificate Provisioning System API
. This behavior can be used in includes. - base_
directory GetProperty Rules Builder Rules V20230105Behavior Base Directory - Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
- boss_
beaconing GetProperty Rules Builder Rules V20230105Behavior Boss Beaconing - Triggers diagnostic data beacons for use with BOSS, Akamai's monitoring and diagnostics system. This behavior is for internal usage only. This behavior can be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Breadcrumbs - Provides per-HTTP transaction visibility into a request for content, regardless of how deep the request goes into the Akamai platform. The
Akamai-Request-BC
response header includes various data, such as network health and the location in the Akamai network used to serve content, which simplifies log review for troubleshooting. This behavior can be used in includes. - break_
connection GetProperty Rules Builder Rules V20230105Behavior Break Connection - This behavior simulates an origin connection problem, typically to test an accompanying
failAction
policy. This behavior can be used in includes. - brotli
Get
Property Rules Builder Rules V20230105Behavior Brotli - Accesses Brotli-compressed assets from your origin and caches them on edge servers. This doesn't compress resources within the content delivery network in real time. You need to set up Brotli compression separately on your origin. If a requesting client doesn't support Brotli, edge servers deliver non-Brotli resources. This behavior can be used in includes.
- cache_
error GetProperty Rules Builder Rules V20230105Behavior Cache Error - Caches the origin's error responses to decrease server load. Applies for 10 seconds by default to the following HTTP codes:
204
,305
,404
,405
,501
,502
,503
,504
, and505
. This behavior can be used in includes. - cache_
id GetProperty Rules Builder Rules V20230105Behavior Cache Id - Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
- cache_
key_ Getignore_ case Property Rules Builder Rules V20230105Behavior Cache Key Ignore Case - By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that
File.html
andfile.html
use separate cache keys. Enabling this behavior forces URL components whose case varies to resolve to the same cache key. Enable this behavior if your origin server is already case-insensitive, such as those based on Microsoft IIS. This behavior can be used in includes. - cache_
key_ Getquery_ params Property Rules Builder Rules V20230105Behavior Cache Key Query Params - By default, cache keys are formed as URLs with full query strings. This behavior allows you to consolidate cached objects based on specified sets of query parameters. This behavior can be used in includes.
- cache_
key_ Getrewrite Property Rules Builder Rules V20230105Behavior Cache Key Rewrite - This behavior rewrites a default cache key's path. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- cache_
post GetProperty Rules Builder Rules V20230105Behavior Cache Post - By default, POST requests are passed to the origin. This behavior overrides the default, and allows you to cache POST responses. This behavior can be used in includes.
- cache_
redirect GetProperty Rules Builder Rules V20230105Behavior Cache Redirect - Controls the caching of HTTP 302 and 307 temporary redirects. By default, Akamai edge servers don't cache them. Enabling this behavior instructs edge servers to allow these redirects to be cached the same as HTTP 200 responses. This behavior can be used in includes.
- cache_
tag GetProperty Rules Builder Rules V20230105Behavior Cache Tag - This adds a cache tag to the requested object. With cache tags, you can flexibly fast purge tagged segments of your cached content. You can either define these tags with an
Edge-Cache-Tag
header at the origin server level, or use this behavior to directly add a cache tag to the object as the edge server caches it. ThecacheTag
behavior can only take a single value, including a variable. If you want to specify more tags for an object, add a few instances of this behavior to your configuration. This behavior can be used in includes. - cache_
tag_ Getvisible Property Rules Builder Rules V20230105Behavior Cache Tag Visible - Cache tags are comma-separated string values you define within an
Edge-Cache-Tag
header. You can use them to flexibly fast purge tagged segments of your cached content. You can either define these headers at the origin server level, or use themodifyOutgoingResponseHeader
behavior to configure them at the edge. Apply this behavior to confirm you're deploying the intended set of cache tags to your content. This behavior can be used in includes. - caching
Get
Property Rules Builder Rules V20230105Behavior Caching - Control content caching on edge servers: whether or not to cache, whether to honor the origin's caching headers, and for how long to cache. Note that any
NO_STORE
orBYPASS_CACHE
HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see theLearn about caching
section in the guide. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Central Authorization - Forward client requests to the origin server for authorization, along with optional
Set-Cookie
headers, useful when you need to maintain tight access control. The edge server forwards anIf-Modified-Since
header, to which the origin needs to respond with a304
(Not-Modified) HTTP status when authorization succeeds. If so, the edge server responds to the client with the cached object, since it does not need to be re-acquired from the origin. This behavior can be used in includes. - chase_
redirects GetProperty Rules Builder Rules V20230105Behavior Chase Redirects - Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
- client_
characteristics GetProperty Rules Builder Rules V20230105Behavior Client Characteristics - Specifies characteristics of the client ecosystem. Akamai uses this information to optimize your metadata configuration, which may result in better end-user performance. This behavior can be used in includes.
- cloud_
interconnects GetProperty Rules Builder Rules V20230105Behavior Cloud Interconnects - Cloud Interconnects forwards traffic from edge servers to your cloud origin through Private Network Interconnects (PNIs), helping to reduce the egress costs at the origin. Supports origins hosted by Google Cloud Provider (GCP). This behavior cannot be used in includes.
- cloud_
wrapper GetProperty Rules Builder Rules V20230105Behavior Cloud Wrapper Cloud Wrapper
maximizes origin offload for large libraries of video, game, and software downloads by optimizing data caches in regions nearest to your origin. You can't use this behavior in conjunction withsureRoute
ortieredDistribution
. This behavior cannot be used in includes.- cloud_
wrapper_ Getadvanced Property Rules Builder Rules V20230105Behavior Cloud Wrapper Advanced - Your account representative uses this behavior to implement a customized failover configuration on your behalf. Use Cloud Wrapper Advanced with an enabled
cloudWrapper
behavior in the same rule. This behavior is for internal usage only. This behavior cannot be used in includes. - conditional_
origin GetProperty Rules Builder Rules V20230105Behavior Conditional Origin - This behavior cannot be used in includes.
- construct_
response GetProperty Rules Builder Rules V20230105Behavior Construct Response - This behavior constructs an HTTP response, complete with HTTP status code and body, to serve from the edge independently of your origin. For example, you might want to send a customized response if the URL doesn't point to an object on the origin server, or if the end user is not authorized to view the requested content. You can use it with all request methods you allow for your property, including POST. For more details, see the
allowOptions
,allowPatch
,allowPost
,allowPut
, andallowDelete
behaviors. This behavior can be used in includes. - content_
characteristics GetProperty Rules Builder Rules V20230105Behavior Content Characteristics - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content_
characteristics_ Getamd Property Rules Builder Rules V20230105Behavior Content Characteristics Amd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content_
characteristics_ Getdd Property Rules Builder Rules V20230105Behavior Content Characteristics Dd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content_
characteristics_ Getwsd_ large_ file Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Large File - Specifies characteristics of the delivered content, specifically targeted to delivering large files. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content_
characteristics_ Getwsd_ live Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Live - Specifies characteristics of the delivered content, specifically targeted to delivering live video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content_
characteristics_ Getwsd_ vod Property Rules Builder Rules V20230105Behavior Content Characteristics Wsd Vod - Specifies characteristics of the delivered content, specifically targeted to delivering on-demand video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content_
pre_ Getposition Property Rules Builder Rules V20230105Behavior Content Pre Position - Content Preposition. This behavior can be used in includes.
- content_
targeting_ Getprotection Property Rules Builder Rules V20230105Behavior Content Targeting Protection - Content Targeting is based on
EdgeScape
, Akamai's location-based access control system. You can use it to allow or deny access to a set of geographic regions or IP addresses. This behavior can be used in includes. - cors_
support GetProperty Rules Builder Rules V20230105Behavior Cors Support - Cross-origin resource sharing (CORS) allows web pages in one domain to access restricted resources from your domain. Specify external origin hostnames, methods, and headers that you want to accept via HTTP response headers. Full support of CORS requires allowing requests that use the OPTIONS method. See
allowOptions
. This behavior can be used in includes. - cp_
code GetProperty Rules Builder Rules V20230105Behavior Cp Code - Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. You receive an initial CP code when purchasing Akamai, and you can run the
Create a new CP code
operation to generate more. This behavior applies any valid CP code, either as required as a default at the top of the rule tree, or subsequently to override the default. For a CP code to be valid, it needs to be assigned the same contract and product as the property, and the group needs access to it. For available values, run theList CP codes
operation. This behavior can be used in includes. - custom_
behavior GetProperty Rules Builder Rules V20230105Behavior Custom Behavior - Allows you to insert a customized XML metadata behavior into any property's rule tree. Talk to your Akamai representative to implement the customized behavior. Once it's ready, run PAPI's
List custom behaviors
operation, then apply the relevantbehaviorId
value from the response within the currentcustomBehavior
. SeeCustom behaviors and overrides
for guidance on custom metadata behaviors. This behavior can be used in includes. - datastream
Get
Property Rules Builder Rules V20230105Behavior Datastream - The
DataStream
reporting service provides real-time logs on application activity, including aggregated metrics on complete request and response cycles and origin response times. Apply this behavior to report on this set of traffic. Use theDataStream API
to aggregate the data. This behavior cannot be used in includes. - dcp
Get
Property Rules Builder Rules V20230105Behavior Dcp - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (TheIoT Edge Connect API
allows programmatic access.) This behavior allows you to select previously reserved namespaces and set the protocols for users to publish and receive messages within these namespaces. Use theverifyJsonWebTokenForDcp
behavior to control access. This behavior cannot be used in includes. - dcp_
auth_ Gethmac_ transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Hmac Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then generates a hash value based on the selected algorithm, for use in authenticating the client request. This behavior cannot be used in includes. - dcp_
auth_ Getregex_ transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Regex Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then transforms the string based on a regular expression search pattern, for use in authenticating the client request. This behavior cannot be used in includes. - dcp_
auth_ Getsubstring_ transformation Property Rules Builder Rules V20230105Behavior Dcp Auth Substring Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then extracts a substring, for use in authenticating the client request. This behavior cannot be used in includes. - dcp_
auth_ Getvariable_ extractor Property Rules Builder Rules V20230105Behavior Dcp Auth Variable Extractor - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. When enabled, this behavior allows end users to authenticate their requests with valid x509 client certificates. Either a client identifier or access authorization groups are required to make the request valid. This behavior cannot be used in includes. - dcp_
default_ Getauthz_ groups Property Rules Builder Rules V20230105Behavior Dcp Default Authz Groups - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior defines a set of default authorization groups to add to each request the property configuration controls. These groups have access regardless of the authentication method you use, either JWT using theverifyJsonWebTokenForDcp
behavior, or mutual authentication using thedcpAuthVariableExtractor
behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes. - dcp_
dev_ Getrelations Property Rules Builder Rules V20230105Behavior Dcp Dev Relations - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior allows Akamai-external clients to use developer test accounts in a shared environment. In conjunction withverifyJsonWebTokenForDcp
, this behavior allows you to use your own JWTs in your requests, or those generated by Akamai. It lets you either enable the default JWT server for your test configuration by setting the authentication endpoint to a default path, or specify custom settings for your JWT server and the authentication endpoint. This behavior cannot be used in includes. - dcp_
real_ Gettime_ auth Property Rules Builder Rules V20230105Behavior Dcp Real Time Auth - INTERNAL ONLY: The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior lets you configure the real time authentication to edge servers. This behavior is for internal usage only. This behavior cannot be used in includes. - delivery_
receipt GetProperty Rules Builder Rules V20230105Behavior Delivery Receipt - A static behavior that's required when specifying the Cloud Monitor module's (
edgeConnect
behavior. You can only apply this behavior if the property is marked as secure. SeeSecure property requirements
for guidance. This behavior can be used in includes. - deny_
access GetProperty Rules Builder Rules V20230105Behavior Deny Access - Assuming a condition in the rule matches, this denies access to the requested content. For example, a
userLocation
match paired with this behavior would deny requests from a specified part of the world. This behavior can be used in includes. - deny_
direct_ Getfailover_ access Property Rules Builder Rules V20230105Behavior Deny Direct Failover Access - A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- device_
characteristic_ Getcache_ id Property Rules Builder Rules V20230105Behavior Device Characteristic Cache Id - By default, source URLs serve as cache IDs on edge servers. Electronic Data Capture allows you to specify an additional set of device characteristics to generate separate cache keys. Use this in conjunction with the
deviceCharacteristicHeader
behavior. This behavior can be used in includes. - device_
characteristic_ Getheader Property Rules Builder Rules V20230105Behavior Device Characteristic Header - Sends selected information about requesting devices to the origin server, in the form of an
X-Akamai-Device-Characteristics
HTTP header. Use in conjunction with thedeviceCharacteristicCacheId
behavior. This behavior can be used in includes. - dns_
async_ Getrefresh Property Rules Builder Rules V20230105Behavior Dns Async Refresh - Allow an edge server to use an expired DNS record when forwarding a request to your origin. The
type A
DNS record refreshesafter
content is served to the end user, so there is no wait for the DNS resolution. Avoid this behavior if you want to be able to disable a server immediately after its DNS record expires. This behavior can be used in includes. - dns_
prefresh GetProperty Rules Builder Rules V20230105Behavior Dns Prefresh - Allows edge servers to refresh your origin's DNS record independently from end-user requests. The
type A
DNS record refreshes before the origin's DNS record expires. This behavior is for internal usage only. This behavior can be used in includes. - downgrade_
protocol GetProperty Rules Builder Rules V20230105Behavior Downgrade Protocol - Serve static objects to the end-user client over HTTPS, but fetch them from the origin via HTTP. This behavior cannot be used in includes.
- download_
complete_ Getmarker Property Rules Builder Rules V20230105Behavior Download Complete Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes. - download_
notification GetProperty Rules Builder Rules V20230105Behavior Download Notification - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior allows requests to theOTA Updates API
for a list of completed downloads to individual vehicles. This behavior cannot be used in includes. - downstream_
cache GetProperty Rules Builder Rules V20230105Behavior Downstream Cache - Specify the caching instructions the edge server sends to the end user's client or client proxies. By default, the cache's duration is whichever is less: the remaining lifetime of the edge cache, or what the origin's header specifies. If the origin is set to
no-store
orbypass-cache
, edge servers sendcache-busting
headers downstream to prevent downstream caching. This behavior can be used in includes. - dynamic_
throughtput_ Getoptimization Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization - Enables
quick retry
, which detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. By default, connections under 5 mbps trigger this behavior. When the transfer rate drops below this rate during a connection attempt, quick retry is enabled and a different forward connection path is used. Contact Akamai Professional Services to override this threshold. This behavior can be used in includes. - dynamic_
throughtput_ Getoptimization_ override Property Rules Builder Rules V20230105Behavior Dynamic Throughtput Optimization Override - This overrides the default threshold of 5 Mbps that triggers the
dynamicThroughtputOptimization
behavior, which enables the quick retry feature. Quick retry detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. This behavior is for internal usage only. This behavior can be used in includes. - dynamic_
web_ Getcontent Property Rules Builder Rules V20230105Behavior Dynamic Web Content - In conjunction with the
subCustomer
behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers usingAkamai Cloud Embed
. This behavior can be used in includes. - ecms_
bulk_ Getupload Property Rules Builder Rules V20230105Behavior Ecms Bulk Upload - Uploads a ZIP archive with objects to an existing data set. The target data set stores objects as key-value pairs. The path to an object in the ZIP archive is a key, and the content of an object is a value. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - ecms_
database GetProperty Rules Builder Rules V20230105Behavior Ecms Database - Edge Connect Message Store is available for
Internet of Things: Edge Connect
users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB.ecmsDatabase
specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure theecmsDataset
behavior to specify a default data set for requests. This behavior cannot be used in includes. - ecms_
dataset GetProperty Rules Builder Rules V20230105Behavior Ecms Dataset - Specifies a default data set for requests to this property unless indicated otherwise in the URL. To access objects in this data set, you can skip the data set name in the URLs. To access objects in a different data set within a database, pass the data set name in the header, query parameter, or a regular expression pattern matching a URL segment. You can also configure the
ecmsDatabase
behavior to specify a default database for requests. This behavior cannot be used in includes. - ecms_
object_ Getkey Property Rules Builder Rules V20230105Behavior Ecms Object Key - Defines a regular expression to match object keys in custom URLs and to access objects in a data set. You can point custom URLs to access proper values in the target data set. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - edge_
connect GetProperty Rules Builder Rules V20230105Behavior Edge Connect - Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
- edge_
load_ Getbalancing_ advanced Property Rules Builder Rules V20230105Behavior Edge Load Balancing Advanced - This behavior implements customized Edge Load Balancing features. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior cannot be used in includes.
- edge_
load_ Getbalancing_ data_ center Property Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center - The Edge Load Balancing module allows you to specify groups of data centers that implement load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- edge_
load_ Getbalancing_ origin Property Rules Builder Rules V20230105Behavior Edge Load Balancing Origin - The Edge Load Balancing module allows you to implement groups of data centers featuring load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- Get
Property Rules Builder Rules V20230105Behavior Edge Origin Authorization - Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
- edge_
redirector GetProperty Rules Builder Rules V20230105Behavior Edge Redirector - This behavior enables the
Edge Redirector Cloudlet
application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control the Edge Redirector withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - edge_
scape GetProperty Rules Builder Rules V20230105Behavior Edge Scape EdgeScape
allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a specialX-Akamai-Edgescape
header to the origin server encoding relevant details about the end-user client as key-value pairs. This behavior can be used in includes.- edge_
side_ Getincludes Property Rules Builder Rules V20230105Behavior Edge Side Includes - Allows edge servers to process edge side include (ESI) code to generate dynamic content. To apply this behavior, you need to match on a
contentType
,path
, orfilename
. Since this behavior requires more parsing time, you should not apply it to pages that lack ESI code, or to any non-HTML content. This behavior can be used in includes. - edge_
worker GetProperty Rules Builder Rules V20230105Behavior Edge Worker EdgeWorkers
are JavaScript applications that allow you to manipulate your web traffic on edge servers outside of Property Manager behaviors, and deployed independently from your configuration's logic. This behavior applies an EdgeWorker to a set of edge requests. This behavior cannot be used in includes.- enhanced_
akamai_ Getprotocol Property Rules Builder Rules V20230105Behavior Enhanced Akamai Protocol - Enables the Enhanced Akamai Protocol, a suite of advanced routing and transport optimizations that increase your website's performance and reliability. It is only available to specific applications, and requires a special routing from edge to origin. This behavior can be used in includes.
- enhanced_
proxy_ Getdetection Property Rules Builder Rules V20230105Behavior Enhanced Proxy Detection - Enhanced Proxy Detection (EPD) leverages the GeoGuard service provided by GeoComply to add proxy detection and location spoofing protection. It identifies requests for your content that have been redirected from an unwanted source through a proxy. You can then allow, deny, or redirect these requests. This behavior can be used in includes.
- epd_
forward_ Getheader_ enrichment Property Rules Builder Rules V20230105Behavior Epd Forward Header Enrichment - This behavior identifies unwanted requests from an anonymous proxy. This and the
enhancedProxyDetection
behavior work together and need to be included either in the same rule, or in the default one. This behavior can be used in includes. - fail_
action GetProperty Rules Builder Rules V20230105Behavior Fail Action - Specifies how to respond when the origin is not available: by serving stale content, by serving an error page, or by redirecting. To apply this behavior, you should match on an
originTimeout
ormatchResponseCode
. This behavior can be used in includes. - failover_
bot_ Getmanager_ feature_ compatibility Property Rules Builder Rules V20230105Behavior Failover Bot Manager Feature Compatibility - Ensures that functionality such as challenge authentication and reset protocol work with a failover product property you use to create an alternate hostname. Apply it to any properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- fast_
invalidate GetProperty Rules Builder Rules V20230105Behavior Fast Invalidate - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- first_
party_ Getmarketing Property Rules Builder Rules V20230105Behavior First Party Marketing - Enables the Cloud Marketing Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketingPlus
behavior, which integrates better with both MediaMath and its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - first_
party_ Getmarketing_ plus Property Rules Builder Rules V20230105Behavior First Party Marketing Plus - Enables the Cloud Marketing Plus Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketing
behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - forward_
rewrite GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite - The Forward Rewrite Cloudlet allows you to conditionally modify the forward path in edge content without affecting the URL that displays in the user's address bar. If Cloudlets are available on your contract, choose
Your services
>Edge logic Cloudlets
to control how this feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - front_
end_ Getoptimization Property Rules Builder Rules V20230105Behavior Front End Optimization - This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
- g2oheader
Get
Property Rules Builder Rules V20230105Behavior G2oheader - The
signature header authentication
(g2o) security feature provides header-based verification of outgoing origin requests. Edge servers encrypt request data in a pre-defined header, which the origin uses to verify that the edge server processed the request. This behavior configures the request data, header names, encryption algorithm, and shared secret to use for verification. This behavior can be used in includes. - global_
request_ Getnumber Property Rules Builder Rules V20230105Behavior Global Request Number - Generates a unique identifier for each request on the Akamai edge network, for use in logging and debugging. GRN identifiers follow the same format as Akamai's error reference strings, for example:
0.05313217.1567801841.1457a3
. You can use the Edge Diagnostics API'sTranslate error string
operation to get low-level details about any request. This behavior can be used in includes. - graphql_
caching GetProperty Rules Builder Rules V20230105Behavior Graphql Caching - This behavior configures how to cache GraphQL-based API traffic. Enable
caching
for your GraphQL API traffic, along withallowPost
to cache POST responses. To configure REST API traffic, use therapid
behavior. This behavior can be used in includes. - gzip_
response GetProperty Rules Builder Rules V20230105Behavior Gzip Response - Apply
gzip
compression to speed transfer time. This behavior applies best to text-based content such as HTML, CSS, and JavaScript, especially once files exceed about 10KB. Do not apply it to already compressed image formats, or to small files that would add more time to uncompress. To apply this behavior, you should match oncontentType
or the content'scacheability
. This behavior can be used in includes. - hd_
data_ Getadvanced Property Rules Builder Rules V20230105Behavior Hd Data Advanced - This behavior specifies Akamai XML metadata that can only be configured on your behalf by Akamai Professional Services. Unlike the
advanced
behavior, this may apply a different set of overriding metadata that executes in a post-processing phase. This behavior is for internal usage only. This behavior can be used in includes. - health_
detection GetProperty Rules Builder Rules V20230105Behavior Health Detection - Monitors the health of your origin server by tracking unsuccessful attempts to contact it. Use this behavior to keep end users from having to wait several seconds before a forwarded request times out, or to reduce requests on the origin server when it is unavailable. This behavior can be used in includes.
- hsaf_
eip_ Getbinding Property Rules Builder Rules V20230105Behavior Hsaf Eip Binding - Edge IP Binding works with a limited set of static IP addresses to distribute your content, which can be limiting in large footprint environments. This behavior sets Hash Serial and Forward (HSAF) for Edge IP Binding to deal with larger footprints. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- http2
Get
Property Rules Builder Rules V20230105Behavior Http2 - Enables the HTTP/2 protocol, which reduces latency and improves efficiency. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
for guidance. This behavior cannot be used in includes. - http3
Get
Property Rules Builder Rules V20230105Behavior Http3 - This enables the HTTP/3 protocol that uses QUIC. The behavior allows for improved performance and faster connection setup. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
and theProperty Manager documentation
for guidance. This behavior cannot be used in includes. - http_
strict_ Gettransport_ security Property Rules Builder Rules V20230105Behavior Http Strict Transport Security - Applies HTTP Strict Transport Security (HSTS), disallowing insecure HTTP traffic. Apply this to hostnames managed with Standard TLS or Enhanced TLS certificates. This behavior cannot be used in includes.
- http_
to_ Gethttps_ upgrade Property Rules Builder Rules V20230105Behavior Http To Https Upgrade - Upgrades an HTTP edge request to HTTPS for the remainder of the request flow. Enable this behavior only if your origin supports HTTPS, and if your
origin
behavior is configured withoriginCertsToHonor
to verify SSL certificates. This behavior can be used in includes. - im_
override GetProperty Rules Builder Rules V20230105Behavior Im Override - This specifies common query parameters that affect how
imageManager
transforms images, potentially overriding policy, width, format, or density request parameters. This also allows you to assign the value of one of the property'srule tree variables
to one of Image and Video Manager's own policy variables. This behavior can be used in includes. - image_
and_ Getvideo_ manager Property Rules Builder Rules V20230105Behavior Image And Video Manager - This behavior can be used in includes.
- image_
manager GetProperty Rules Builder Rules V20230105Behavior Image Manager - Optimizes images' size or file type for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching images using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. Once you apply Image and Video Manager to traffic, you can add theadvancedImMatch
to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes. - image_
manager_ Getvideo Property Rules Builder Rules V20230105Behavior Image Manager Video - Optimizes videos managed by Image and Video Manager for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching videos using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. This behavior can be used in includes. - include
Get
Property Rules Builder Rules V20230105Behavior Include - Includes let you reuse chunks of a property configuration that you can manage separately from the rest of the property rule tree. This behavior cannot be used in includes.
- input_
validation GetProperty Rules Builder Rules V20230105Behavior Input Validation - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- instant
Get
Property Rules Builder Rules V20230105Behavior Instant - The Instant feature allows you to prefetch content to the edge cache by adding link relation attributes to markup. For example: This behavior can be used in includes.
- instant_
config GetProperty Rules Builder Rules V20230105Behavior Instant Config - Multi-Domain Configuration, also known as
InstantConfig
, allows you to apply property settings to all incoming hostnames based on a DNS lookup, without explicitly listing them among the property's hostnames. This behavior cannot be used in includes. - large_
file_ Getoptimization Property Rules Builder Rules V20230105Behavior Large File Optimization - The
Large File Optimization
(LFO) feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and you should apply it to anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files, and enable theuseVersioning
option while enforcing your own filename versioning policy. Make sure you meet all therequirements and best practices
for the LFO delivery. This behavior can be used in includes. - large_
file_ Getoptimization_ advanced Property Rules Builder Rules V20230105Behavior Large File Optimization Advanced - The
Large File Optimization
feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and it's recommended for anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files. Note that it is best to useNetStorage
for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes. - limit_
bit_ Getrate Property Rules Builder Rules V20230105Behavior Limit Bit Rate - Control the rate at which content serves out to end users, optionally varying the speed depending on the file size or elapsed download time. Each bit rate specified in the
bitrateTable
array corresponds to athresholdTable
entry that activates it. You can use this behavior to prevent media downloads from progressing faster than they are viewed, for example, or to differentiate various tiers of end-user experience. To apply this behavior, you should match on acontentType
,path
, orfilename
. This behavior can be used in includes. - log_
custom GetProperty Rules Builder Rules V20230105Behavior Log Custom - Logs custom details from the origin response in the
Log Delivery Service
report. This behavior can be used in includes. - m_
pulse GetProperty Rules Builder Rules V20230105Behavior MPulse mPulse
provides high-level performance analytics and predictive recommendations based on real end user data. See themPulse Quick Start
to set up mPulse on your website. This behavior cannot be used in includes.- manifest_
personalization GetProperty Rules Builder Rules V20230105Behavior Manifest Personalization - Allows customers who use the Adaptive Media Delivery product to enhance content based on the capabilities of each end user's device. This behavior configures a
manifest
for both HLS Live and on-demand streaming. For more information, seeAdaptive Media Delivery
. This behavior can be used in includes. - manifest_
rerouting GetProperty Rules Builder Rules V20230105Behavior Manifest Rerouting - This behavior works with
adScalerCircuitBreaker
. It delegates parts of the media delivery workflow, like ad insertion, to other technology partners. Akamai reroutes manifest file requests to partner platforms for processing prior to being delivered. Rerouting simplifies the workflow and improves the media streaming experience. This behavior cannot be used in includes. - manual_
server_ Getpush Property Rules Builder Rules V20230105Behavior Manual Server Push - With the
http2
behavior enabled, this loads a specified set of objects into the client browser's cache. To apply this behavior, you should match on apath
orfilename
. This behavior cannot be used in includes. - media_
acceleration GetProperty Rules Builder Rules V20230105Behavior Media Acceleration - Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
- media_
acceleration_ Getquic_ optout Property Rules Builder Rules V20230105Behavior Media Acceleration Quic Optout - When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
- media_
client GetProperty Rules Builder Rules V20230105Behavior Media Client - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- media_
file_ Getretrieval_ optimization Property Rules Builder Rules V20230105Behavior Media File Retrieval Optimization - Media File Retrieval Optimization (MFRO) speeds the delivery of large media files by relying on caches of partial objects. You should use it for files larger than 100 MB. It's required for files larger than 1.8 GB, and works best with
NetStorage
. To apply this behavior, you should match on afileExtension
. This behavior can be used in includes. - media_
origin_ Getfailover Property Rules Builder Rules V20230105Behavior Media Origin Failover - Specifies how edge servers respond when the origin is unresponsive, or suffers from server or content errors. You can specify how many times to retry, switch to a backup origin hostname, or configure a redirect. This behavior can be used in includes.
- metadata_
caching GetProperty Rules Builder Rules V20230105Behavior Metadata Caching - This behavior reduces time spent waiting for the initial response, also known as time to first byte, during peak traffic events. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- mobile_
sdk_ Getperformance Property Rules Builder Rules V20230105Behavior Mobile Sdk Performance - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- modify_
incoming_ Getrequest_ header Property Rules Builder Rules V20230105Behavior Modify Incoming Request Header - Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
- modify_
incoming_ Getresponse_ header Property Rules Builder Rules V20230105Behavior Modify Incoming Response Header - Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
- modify_
outgoing_ Getrequest_ header Property Rules Builder Rules V20230105Behavior Modify Outgoing Request Header - Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
- modify_
outgoing_ Getresponse_ header Property Rules Builder Rules V20230105Behavior Modify Outgoing Response Header - Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
- modify_
via_ Getheader Property Rules Builder Rules V20230105Behavior Modify Via Header - Removes or renames the HTTP
Via
headers used to inform the server of proxies through which the request was sent to the origin. This behavior can be used in includes. - origin
Get
Property Rules Builder Rules V20230105Behavior Origin - Specify the hostname and settings used to contact the origin once service begins. You can use your own origin,
NetStorage
, an Edge Load Balancing origin, or a SaaS dynamic origin. This behavior can be used in includes. - origin_
characteristics GetProperty Rules Builder Rules V20230105Behavior Origin Characteristics - Specifies characteristics of the origin. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior cannot be used in includes.
- origin_
characteristics_ Getwsd Property Rules Builder Rules V20230105Behavior Origin Characteristics Wsd - Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
- origin_
failure_ Getrecovery_ method Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Method - Origin Failover requires that you set up a separate rule containing origin failure recovery methods. You also need to set up the Origin Failure Recovery Policy behavior in a separate rule with a desired match criteria, and select the desired failover method. You can do this using Property Manager. Learn more about this process in
Adaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryPolicy
member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes. - origin_
failure_ Getrecovery_ policy Property Rules Builder Rules V20230105Behavior Origin Failure Recovery Policy - Configures how to detect an origin failure, in which case the
originFailureRecoveryMethod
behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process inAdaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryMethod
member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes. - origin_
ip_ Getacl Property Rules Builder Rules V20230105Behavior Origin Ip Acl - Origin IP Access Control List limits the traffic to your origin. It only allows requests from specific edge servers that are configured as part of a supernet defined by CIDR blocks. This behavior can be used in includes.
- persistent_
client_ Getconnection Property Rules Builder Rules V20230105Behavior Persistent Client Connection - This behavior activates
persistent connections
between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with thepersistentConnection
behavior, which configures persistent connections for the entire journey from origin to edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - persistent_
connection GetProperty Rules Builder Rules V20230105Behavior Persistent Connection - This behavior enables more efficient
persistent connections
from origin to edge server to client. Compare with thepersistentClientConnection
behavior, which customizes persistent connections from edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - personally_
identifiable_ Getinformation Property Rules Builder Rules V20230105Behavior Personally Identifiable Information - Marks content covered by the current rule as sensitive
personally identifiable information
that needs to be treated as secure and private. That includes anything involving personal information: name, social security number, date and place of birth, mother's maiden name, biometric data, or any other data linked to an individual. If you attempt to save a property with such a rule that also caches or logs sensitive content, the added behavior results in a validation error. This behavior cannot be used in includes. - phased_
release GetProperty Rules Builder Rules V20230105Behavior Phased Release - The Phased Release Cloudlet provides gradual and granular traffic management to an alternate origin in near real time. Use the
Cloudlets API
or the Cloudlets Policy Manager application withinControl Center
to set up your Cloudlets policies. This behavior cannot be used in includes. - preconnect
Get
Property Rules Builder Rules V20230105Behavior Preconnect - With the
http2
behavior enabled, this requests a specified set of domains that relate to your property hostname, and keeps the connection open for faster loading of content from those domains. This behavior can be used in includes. - predictive_
content_ Getdelivery Property Rules Builder Rules V20230105Behavior Predictive Content Delivery - Improves user experience and reduces the cost of downloads by enabling mobile devices to predictively fetch and cache content from catalogs managed by Akamai servers. You can't use this feature if in the
segmentedMediaOptimization
behavior, the value forbehavior
is set toLIVE
. This behavior can be used in includes. - predictive_
prefetching GetProperty Rules Builder Rules V20230105Behavior Predictive Prefetching - This behavior potentially reduces the client's page load time by pre-caching objects based on historical data for the page, not just its current set of referenced objects. It also detects second-level dependencies, such as objects retrieved by JavaScript. This behavior can be used in includes.
- prefetch
Get
Property Rules Builder Rules V20230105Behavior Prefetch - Instructs edge servers to retrieve content linked from requested pages as they load, rather than waiting for separate requests for the linked content. This behavior applies depending on the rule's set of matching conditions. Use in conjunction with the
prefetchable
behavior, which specifies the set of objects to prefetch. This behavior can be used in includes. - prefetchable
Get
Property Rules Builder Rules V20230105Behavior Prefetchable - Allow matching objects to prefetch into the edge cache as the parent page that links to them loads, rather than waiting for a direct request. This behavior applies depending on the rule's set of matching conditions. Use
prefetch
to enable the overall behavior for parent pages that contain links to the object. To apply this behavior, you need to match on afilename
orfileExtension
. This behavior can be used in includes. - prefresh_
cache GetProperty Rules Builder Rules V20230105Behavior Prefresh Cache - Refresh cached content before its time-to-live (TTL) expires, to keep end users from having to wait for the origin to provide fresh content. This behavior can be used in includes.
- quality
Get
Property Rules Builder Rules V20230105Behavior Quality - This behavior can be used in includes.
- quic_
beta GetProperty Rules Builder Rules V20230105Behavior Quic Beta - For a share of responses, includes an
Alt-Svc
header for compatible clients to initiate subsequent sessions using the QUIC protocol. This behavior cannot be used in includes. - random_
seek GetProperty Rules Builder Rules V20230105Behavior Random Seek - Optimizes
.flv
and.mp4
files to allow random jump-point navigation. This behavior can be used in includes. - rapid
Get
Property Rules Builder Rules V20230105Behavior Rapid - The
Akamai API Gateway
allows you to configure API traffic delivered over the Akamai network. Apply this behavior to a set of API assets, then use Akamai'sAPI Endpoints API
to configure how the traffic responds. Use theAPI Keys and Traffic Management API
to control access to your APIs. This behavior cannot be used in includes. - read_
timeout GetProperty Rules Builder Rules V20230105Behavior Read Timeout - This behavior specifies how long the edge server should wait for a response from the requesting forward server after a connection has already been established. This behavior can be used in includes.
- real_
time_ Getreporting Property Rules Builder Rules V20230105Behavior Real Time Reporting - This enables Real-Time Reporting for Akamai
Cloud Embed
customers. The behavior can only be configured on your behalf by Akamai Professional Services. You can access real-time reports data for that base configuration withMedia Delivery Reports API
. This behavior is for internal usage only. This behavior can be used in includes. - real_
user_ Getmonitoring Property Rules Builder Rules V20230105Behavior Real User Monitoring - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- redirect
Get
Property Rules Builder Rules V20230105Behavior Redirect - Respond to the client request with a redirect without contacting the origin. Specify the redirect as a path expression starting with a
/
character relative to the current root, or as a fully qualified URL. This behavior relies primarily ondestinationHostname
anddestinationPath
to manipulate the hostname and path independently. This behavior can be used in includes. - redirectplus
Get
Property Rules Builder Rules V20230105Behavior Redirectplus - Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as
redirect
, but allows you to usevariables
to express the redirectdestination
's component values more concisely. This behavior can be used in includes. - referer_
checking GetProperty Rules Builder Rules V20230105Behavior Referer Checking - Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
- remove_
query_ Getparameter Property Rules Builder Rules V20230105Behavior Remove Query Parameter - Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
- remove_
vary GetProperty Rules Builder Rules V20230105Behavior Remove Vary - By default, responses that feature a
Vary
header value of anything other thanAccept-Encoding
and a correspondingContent-Encoding: gzip
header aren't cached on edge servers.Vary
headers indicate when a URL's content varies depending on some variable, such as whichUser-Agent
requests it. This behavior simply removes theVary
header to make responses cacheable. This behavior can be used in includes. - report
Get
Property Rules Builder Rules V20230105Behavior Report - Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
- request_
control GetProperty Rules Builder Rules V20230105Behavior Request Control - The Request Control Cloudlet allows you to control access to your web content based on the incoming request's IP or geographic location. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control how the feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - request_
type_ Getmarker Property Rules Builder Rules V20230105Behavior Request Type Marker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. When using thedownloadCompleteMarker
behavior to log successful downloads, this related behavior identifies download or campaign server types in aggregated and individual reports. This behavior can be used in includes. - resource_
optimizer GetProperty Rules Builder Rules V20230105Behavior Resource Optimizer - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- resource_
optimizer_ Getextended_ compatibility Property Rules Builder Rules V20230105Behavior Resource Optimizer Extended Compatibility - This enhances the standard version of the
resourceOptimizer
behavior to support the compression of additional file formats and address some compatibility issues. This behavior can be used in includes. - response_
code GetProperty Rules Builder Rules V20230105Behavior Response Code - Change the existing response code. For example, if your origin sends a
301
permanent redirect, this behavior can change it on the edge to a temporary302
redirect. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Response Cookie - Set a cookie to send downstream to the client with either a fixed value or a unique stamp. This behavior can be used in includes.
- restrict_
object_ Getcaching Property Rules Builder Rules V20230105Behavior Restrict Object Caching - You need this behavior to deploy the Object Caching product. It disables serving HTML content and limits the maximum object size to 100MB. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- return_
cache_ Getstatus Property Rules Builder Rules V20230105Behavior Return Cache Status - Generates a response header with information about cache status. Among other things, this can tell you whether the response came from the Akamai cache, or from the origin. Status values report with either of these forms of syntax, depending for example on whether you're deploying traffic using
sureRoute
ortieredDistribution
: This behavior can be used in includes. - rewrite_
url GetProperty Rules Builder Rules V20230105Behavior Rewrite Url - Modifies the path of incoming requests to forward to the origin. This helps you offload URL-rewriting tasks to the edge to increase the origin server's performance, allows you to redirect links to different targets without changing markup, and hides your original directory structure. This behavior can be used in includes.
- rum_
custom GetProperty Rules Builder Rules V20230105Behavior Rum Custom - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- saas_
definitions GetProperty Rules Builder Rules V20230105Behavior Saas Definitions - Configures how the Software as a Service feature identifies
customers
,applications
, andusers
. A different set of options is available for each type of targeted request, each enabled with theaction
-suffixed option. In each case, you can usePATH
,COOKIE
,QUERY_STRING
, orHOSTNAME
components as identifiers, ordisable
the SaaS behavior for certain targets. If you rely on aHOSTNAME
, you also have the option of specifying aCNAME chain
rather than an individual hostname. The various options suffixedregex
andreplace
subsequently remove the identifier from the request. This behavior requires a siblingorigin
behavior whoseoriginType
option is set toSAAS_DYNAMIC_ORIGIN
. This behavior cannot be used in includes. - sales_
force_ Getcommerce_ cloud_ client Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Client - If you use the Salesforce Commerce Cloud platform for your origin content, this behavior allows your edge content managed by Akamai to contact directly to origin. This behavior cannot be used in includes.
- sales_
force_ Getcommerce_ cloud_ provider Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider - This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- sales_
force_ Getcommerce_ cloud_ provider_ host_ header Property Rules Builder Rules V20230105Behavior Sales Force Commerce Cloud Provider Host Header - Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- save_
post_ Getdca_ processing Property Rules Builder Rules V20230105Behavior Save Post Dca Processing - Used in conjunction with the
cachePost
behavior, this behavior allows the body of POST requests to be processed through Dynamic Content Assembly. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes. - schedule_
invalidation GetProperty Rules Builder Rules V20230105Behavior Schedule Invalidation - Specifies when cached content that satisfies a rule's criteria expires, optionally at repeating intervals. In addition to periodic cache flushes, you can use this behavior to minimize potential conflicts when related objects expire at different times. This behavior can be used in includes.
- script_
management GetProperty Rules Builder Rules V20230105Behavior Script Management - Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. See
Script Management API
for more information. This behavior cannot be used in includes. - segmented_
content_ Getprotection Property Rules Builder Rules V20230105Behavior Segmented Content Protection - Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
- segmented_
media_ Getoptimization Property Rules Builder Rules V20230105Behavior Segmented Media Optimization - Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
- segmented_
media_ Getstreaming_ prefetch Property Rules Builder Rules V20230105Behavior Segmented Media Streaming Prefetch - Prefetches HLS and DASH media stream manifest and segment files, accelerating delivery to end users. For prefetching to work, your origin media's response needs to specify
CDN-Origin-Assist-Prefetch-Path
headers with each URL to prefetch, expressed as either a relative or absolute path. This behavior can be used in includes. - set_
variable GetProperty Rules Builder Rules V20230105Behavior Set Variable - Modify a variable to insert into subsequent fields within the rule tree. Use this behavior to specify the predeclared
variableName
and determine from where to derive its new value. Based on thisvalueSource
, you can either generate the value, extract it from some part of the incoming request, assign it from another variable (including a set of built-in system variables), or directly specify its text. Optionally choose atransform
function to modify the value once. SeeSupport for variables
for more information. This behavior can be used in includes. - shutr
Get
Property Rules Builder Rules V20230105Behavior Shutr - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- simulate_
error_ Getcode Property Rules Builder Rules V20230105Behavior Simulate Error Code - This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- site_
shield GetProperty Rules Builder Rules V20230105Behavior Site Shield - This behavior implements the
Site Shield
feature, which helps prevent non-Akamai machines from contacting your origin. You get an email with a list of Akamai servers allowed to contact your origin, with which you establish an Access Control List on your firewall to prevent any other requests. This behavior cannot be used in includes. - standard_
tls_ Getmigration Property Rules Builder Rules V20230105Behavior Standard Tls Migration - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- standard_
tls_ Getmigration_ override Property Rules Builder Rules V20230105Behavior Standard Tls Migration Override - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- strict_
header_ Getparsing Property Rules Builder Rules V20230105Behavior Strict Header Parsing - This behavior specifies how the edge servers should handle requests containing improperly formatted or invalid headers that don’t comply with
RFC 9110
. This behavior can be used in includes. - sub_
customer GetProperty Rules Builder Rules V20230105Behavior Sub Customer - When positioned in a property's top-level default rule, enables various
Cloud Embed
features that allow you to leverage Akamai's CDN architecture for your own subcustomers. This behavior's options allow you to use Cloud Embed to configure your subcustomers' content. Once enabled, you can use theAkamai Cloud Embed API
(ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also thedynamicWebContent
behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes. - sure_
route GetProperty Rules Builder Rules V20230105Behavior Sure Route - The
SureRoute
feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conductsraces
to identify alternative paths to use in case of a transmission failure. These races increase origin traffic slightly. This behavior cannot be used in includes. - tcp_
optimization GetProperty Rules Builder Rules V20230105Behavior Tcp Optimization - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- tea_
leaf GetProperty Rules Builder Rules V20230105Behavior Tea Leaf - Allows IBM Tealeaf Customer Experience on Cloud to record HTTPS requests and responses for Akamai-enabled properties. Recorded data becomes available in your IBM Tealeaf account. This behavior cannot be used in includes.
- tiered_
distribution GetProperty Rules Builder Rules V20230105Behavior Tiered Distribution - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This behavior cannot be used in includes. - tiered_
distribution_ Getadvanced Property Rules Builder Rules V20230105Behavior Tiered Distribution Advanced - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This advanced behavior provides a wider set of options thantieredDistribution
. This behavior is for internal usage only. This behavior can be used in includes. - tiered_
distribution_ Getcustomization Property Rules Builder Rules V20230105Behavior Tiered Distribution Customization - With Tiered Distribution, Akamai edge servers retrieve cached content from other Akamai servers, rather than directly from the origin. This behavior sets custom Tiered Distribution maps (TD0) and migrates TD1 maps configured with
advanced features
to Cloud Wrapper. You need to enablecloudWrapper
within the same rule. This behavior is for internal usage only. This behavior can be used in includes. - timeout
Get
Property Rules Builder Rules V20230105Behavior Timeout - Sets the HTTP connect timeout. This behavior can be used in includes.
- uid_
configuration GetProperty Rules Builder Rules V20230105Behavior Uid Configuration - This behavior allows you to extract unique identifier (UID) values from live traffic, for use in OTA applications. Note that you are responsible for maintaining the security of any data that may identify individual users. This behavior cannot be used in includes.
- validate_
entity_ Gettag Property Rules Builder Rules V20230105Behavior Validate Entity Tag - Instructs edge servers to compare the request's
ETag
header with that of the cached object. If they differ, the edge server sends a new copy of the object. This validation occurs in addition to the default validation ofLast-Modified
andIf-Modified-Since
headers. This behavior can be used in includes. - verify_
json_ Getweb_ token Property Rules Builder Rules V20230105Behavior Verify Json Web Token - This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
- verify_
json_ Getweb_ token_ for_ dcp Property Rules Builder Rules V20230105Behavior Verify Json Web Token For Dcp - This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing
IoT Edge Connect
, which you use thedcp
behavior to configure. You can specify the location in a request to pass a JSON web token (JWT), collections of public keys to verify the integrity of this token, and specific claims to extract from it. Use theverifyJsonWebToken
behavior for other JWT validation. This behavior can be used in includes. - Get
Property Rules Builder Rules V20230105Behavior Verify Token Authorization - Verifies Auth 2.0 tokens. This behavior can be used in includes.
- virtual_
waiting_ Getroom Property Rules Builder Rules V20230105Behavior Virtual Waiting Room - This behavior helps you maintain business continuity for dynamic applications in high-demand situations such as flash sales. It decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a request processing mechanism that prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control Virtual Waitig Room withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - virtual_
waiting_ Getroom_ with_ edge_ workers Property Rules Builder Rules V20230105Behavior Virtual Waiting Room With Edge Workers - This behavior allows you to configure the
virtualWaitingRoom
behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes. - visitor_
prioritization GetProperty Rules Builder Rules V20230105Behavior Visitor Prioritization - The
Visitor Prioritization Cloudlet
decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - visitor_
prioritization_ Getfifo Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo - (BETA) The
Visitor Prioritization Cloudlet (FIFO)
decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a fair request processing mechanism, which prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization (FIFO) withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - visitor_
prioritization_ Getfifo_ standalone Property Rules Builder Rules V20230105Behavior Visitor Prioritization Fifo Standalone - This behavior cannot be used in includes.
- watermarking
Get
Property Rules Builder Rules V20230105Behavior Watermarking - Adds watermarking for each valid user's content. Content segments are delivered from different sources using a pattern unique to each user, based on a watermarking token included in each request. If your content is pirated or redistributed, you can forensically analyze the segments to extract the pattern, and identify the user who leaked the content. This behavior can be used in includes.
- web_
application_ Getfirewall Property Rules Builder Rules V20230105Behavior Web Application Firewall - This behavior implements a suite of security features that blocks threatening HTTP and HTTPS requests. Use it as your primary firewall, or in addition to existing security measures. Only one referenced configuration is allowed per property, so this behavior typically belongs as part of its default rule. This behavior cannot be used in includes.
- web_
sockets GetProperty Rules Builder Rules V20230105Behavior Web Sockets - The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
- webdav
Get
Property Rules Builder Rules V20230105Behavior Webdav - Web-based Distributed Authoring and Versioning (WebDAV) is a set of extensions to the HTTP protocol that allows users to collaboratively edit and manage files on remote web servers. This behavior enables WebDAV, and provides support for the following additional request methods: PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. To apply this behavior, you need to match on a
requestMethod
. This behavior can be used in includes.
- ad
Scaler Property MapCircuit Breaker - This behavior works with
manifestRerouting
to provide the scale and reliability of Akamai network while simultaneously allowing third party partners to modify the requested media content with value-added features. TheadScalerCircuitBreaker
behavior specifies the fallback action in case the technology partner encounters errors and can't modify the requested media object. This behavior cannot be used in includes. - adaptive
Acceleration Property Map - Adaptive Acceleration uses HTTP/2 server push functionality with Ion properties to pre-position content and improve the performance of HTML page loading based on real user monitoring (RUM) timing data. It also helps browsers to preconnect to content that’s likely needed for upcoming requests. To use this behavior, make sure you enable the
http2
behavior. Use theAdaptive Acceleration API
to report on the set of assets this feature optimizes. This behavior cannot be used in includes. - adaptive
Image Property MapCompression Note: Starting from May 31, 2024, Adaptive Image Compression is no longer supported and the image compression configured through this functionality won't take place. As an alternative, we offer
Image & Video Manager
. It intelligently and automatically optimizes images and videos on the fly for every user. Reach out to your Akamai representatives for more information on this product. This behavior can be used in includes.- advanced Property Map
- This specifies Akamai XML metadata. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- aggregated
Reporting Property Map - Configure a custom report that collects traffic data. The data is based on one to four variables, such as
sum
,average
,min
, andmax
. These aggregation attributes help compile traffic data summaries. This behavior cannot be used in includes. - akamaizer Property Map
- This allows you to run regular expression substitutions over web pages. To apply this behavior, you need to match on a
contentType
. Contact Akamai Professional Services for help configuring the Akamaizer. See also theakamaizerTag
behavior. This behavior is for internal usage only. This behavior can be used in includes. - akamaizer
Tag Property Map - This specifies HTML tags and replacement rules for hostnames used in conjunction with the
akamaizer
behavior. Contact Akamai Professional Services for help configuring the Akamaizer. This behavior is for internal usage only. This behavior can be used in includes. - all
Http Property MapIn Cache Hierarchy - Allow all HTTP request methods to be used for the edge's parent servers, useful to implement features such as
Site Shield
,SureRoute
, and Tiered Distribution. (See thesiteShield
,sureRoute
, andtieredDistribution
behaviors.) This behavior can be used in includes. - allow
Cloudlets Property MapOrigins - Allows Cloudlets Origins to determine the criteria, separately from the Property Manager, under which alternate
origin
definitions are assigned. This behavior cannot be used in includes. - allow
Delete Property Map - Allow HTTP requests using the DELETE method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any DELETE requests pass to the origin. See also the
allowOptions
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Https Property MapCache Key Sharing - HTTPS cache key sharing allows HTTP requests to be served from an HTTPS cache. This behavior can be used in includes.
- allow
Https Property MapDowngrade - Passes HTTPS requests to origin as HTTP. This is useful when incorporating Standard TLS or Akamai's shared certificate delivery security with an origin that serves HTTP traffic. This behavior can be used in includes.
- allow
Options Property Map - GET, HEAD, and OPTIONS requests are allowed by default. All other HTTP methods result in a 501 error. For full support of Cross-Origin Resource Sharing (CORS), you need to allow requests that use the OPTIONS method. If you're using the
corsSupport
behavior, do not disable OPTIONS requests. The response to an OPTIONS request is not cached, so the request always goes through the Akamai network to your origin, unless you use theconstructResponse
behavior to send responses directly from the Akamai network. See also theallowDelete
,allowPatch
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Patch Property Map - Allow HTTP requests using the PATCH method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PATCH requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPost
, andallowPut
behaviors. This behavior can be used in includes. - allow
Post Property Map - Allow HTTP requests using the POST method. By default, GET, HEAD, and OPTIONS requests are allowed, and POST requests are denied with 403 error. All other methods result in a 501 error. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPut
behaviors. This behavior can be used in includes. - allow
Put Property Map - Allow HTTP requests using the PUT method. By default, GET, HEAD, and OPTIONS requests are allowed, and all other methods result in a 501 error. Such content does not cache, and any PUT requests pass to the origin. See also the
allowDelete
,allowOptions
,allowPatch
, andallowPost
behaviors. This behavior can be used in includes. - allow
Transfer Property MapEncoding - Controls whether to allow or deny Chunked Transfer Encoding (CTE) requests to pass to your origin. If your origin supports CTE, you should enable this behavior. This behavior also protects against a known issue when pairing
http2
andwebdav
behaviors within the same rule tree, in which case it's required. This behavior can be used in includes. - alt
Svc Property MapHeader - Sets the maximum age value for the Alternative Services (
Alt-Svc
) header. This behavior can be used in includes. - api
Prioritization Property Map - Enables the API Prioritization Cloudlet, which maintains continuity in user experience by serving an alternate static response when load is too high. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. Use this feature serve static API content, such as fallback JSON data. To serve non-API HTML content, use thevisitorPrioritization
behavior. This behavior can be used in includes. - application
Load Property MapBalancer - Enables the Application Load Balancer Cloudlet, which automates load balancing based on configurable criteria. To configure this behavior, use either the Cloudlets Policy Manager or the
Cloudlets API
to set up a policy. This behavior cannot be used in includes. - audience
Segmentation Property Map - Allows you to divide your users into different segments based on a persistent cookie. You can configure rules using either the Cloudlets Policy Manager application or the
Cloudlets API
. This behavior cannot be used in includes. - auto
Domain Property MapValidation - This behavior allows standard TLS domain validated certificates to renew automatically. Apply it after using the
Certificate Provisioning System
to request a certificate for a hostname. To provision certificates programmatically, see theCertificate Provisioning System API
. This behavior can be used in includes. - base
Directory Property Map - Prefix URLs sent to the origin with a base path. This behavior can be used in includes.
- boss
Beaconing Property Map - Triggers diagnostic data beacons for use with BOSS, Akamai's monitoring and diagnostics system. This behavior is for internal usage only. This behavior can be used in includes.
- Property Map
- Provides per-HTTP transaction visibility into a request for content, regardless of how deep the request goes into the Akamai platform. The
Akamai-Request-BC
response header includes various data, such as network health and the location in the Akamai network used to serve content, which simplifies log review for troubleshooting. This behavior can be used in includes. - break
Connection Property Map - This behavior simulates an origin connection problem, typically to test an accompanying
failAction
policy. This behavior can be used in includes. - brotli Property Map
- Accesses Brotli-compressed assets from your origin and caches them on edge servers. This doesn't compress resources within the content delivery network in real time. You need to set up Brotli compression separately on your origin. If a requesting client doesn't support Brotli, edge servers deliver non-Brotli resources. This behavior can be used in includes.
- cache
Error Property Map - Caches the origin's error responses to decrease server load. Applies for 10 seconds by default to the following HTTP codes:
204
,305
,404
,405
,501
,502
,503
,504
, and505
. This behavior can be used in includes. - cache
Id Property Map - Controls which query parameters, headers, and cookies are included in or excluded from the cache key identifier. This behavior can be used in includes.
- cache
Key Property MapIgnore Case - By default, cache keys are generated under the assumption that path and filename components are case-sensitive, so that
File.html
andfile.html
use separate cache keys. Enabling this behavior forces URL components whose case varies to resolve to the same cache key. Enable this behavior if your origin server is already case-insensitive, such as those based on Microsoft IIS. This behavior can be used in includes. - cache
Key Property MapQuery Params - By default, cache keys are formed as URLs with full query strings. This behavior allows you to consolidate cached objects based on specified sets of query parameters. This behavior can be used in includes.
- cache
Key Property MapRewrite - This behavior rewrites a default cache key's path. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- cache
Post Property Map - By default, POST requests are passed to the origin. This behavior overrides the default, and allows you to cache POST responses. This behavior can be used in includes.
- cache
Redirect Property Map - Controls the caching of HTTP 302 and 307 temporary redirects. By default, Akamai edge servers don't cache them. Enabling this behavior instructs edge servers to allow these redirects to be cached the same as HTTP 200 responses. This behavior can be used in includes.
- cache
Tag Property Map - This adds a cache tag to the requested object. With cache tags, you can flexibly fast purge tagged segments of your cached content. You can either define these tags with an
Edge-Cache-Tag
header at the origin server level, or use this behavior to directly add a cache tag to the object as the edge server caches it. ThecacheTag
behavior can only take a single value, including a variable. If you want to specify more tags for an object, add a few instances of this behavior to your configuration. This behavior can be used in includes. - cache
Tag Property MapVisible - Cache tags are comma-separated string values you define within an
Edge-Cache-Tag
header. You can use them to flexibly fast purge tagged segments of your cached content. You can either define these headers at the origin server level, or use themodifyOutgoingResponseHeader
behavior to configure them at the edge. Apply this behavior to confirm you're deploying the intended set of cache tags to your content. This behavior can be used in includes. - caching Property Map
- Control content caching on edge servers: whether or not to cache, whether to honor the origin's caching headers, and for how long to cache. Note that any
NO_STORE
orBYPASS_CACHE
HTTP headers set on the origin's content override this behavior. For more details on how caching works in Property Manager, see theLearn about caching
section in the guide. This behavior can be used in includes. - Property Map
- Forward client requests to the origin server for authorization, along with optional
Set-Cookie
headers, useful when you need to maintain tight access control. The edge server forwards anIf-Modified-Since
header, to which the origin needs to respond with a304
(Not-Modified) HTTP status when authorization succeeds. If so, the edge server responds to the client with the cached object, since it does not need to be re-acquired from the origin. This behavior can be used in includes. - chase
Redirects Property Map - Controls whether the edge server chases any redirects served from the origin. This behavior can be used in includes.
- client
Characteristics Property Map - Specifies characteristics of the client ecosystem. Akamai uses this information to optimize your metadata configuration, which may result in better end-user performance. This behavior can be used in includes.
- cloud
Interconnects Property Map - Cloud Interconnects forwards traffic from edge servers to your cloud origin through Private Network Interconnects (PNIs), helping to reduce the egress costs at the origin. Supports origins hosted by Google Cloud Provider (GCP). This behavior cannot be used in includes.
- cloud
Wrapper Property Map Cloud Wrapper
maximizes origin offload for large libraries of video, game, and software downloads by optimizing data caches in regions nearest to your origin. You can't use this behavior in conjunction withsureRoute
ortieredDistribution
. This behavior cannot be used in includes.- cloud
Wrapper Property MapAdvanced - Your account representative uses this behavior to implement a customized failover configuration on your behalf. Use Cloud Wrapper Advanced with an enabled
cloudWrapper
behavior in the same rule. This behavior is for internal usage only. This behavior cannot be used in includes. - conditional
Origin Property Map - This behavior cannot be used in includes.
- construct
Response Property Map - This behavior constructs an HTTP response, complete with HTTP status code and body, to serve from the edge independently of your origin. For example, you might want to send a customized response if the URL doesn't point to an object on the origin server, or if the end user is not authorized to view the requested content. You can use it with all request methods you allow for your property, including POST. For more details, see the
allowOptions
,allowPatch
,allowPost
,allowPut
, andallowDelete
behaviors. This behavior can be used in includes. - content
Characteristics Property Map - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics Property MapAmd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics Property MapDd - Specifies characteristics of the delivered content. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics Property MapWsd Large File - Specifies characteristics of the delivered content, specifically targeted to delivering large files. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics Property MapWsd Live - Specifies characteristics of the delivered content, specifically targeted to delivering live video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Characteristics Property MapWsd Vod - Specifies characteristics of the delivered content, specifically targeted to delivering on-demand video. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior can be used in includes.
- content
Pre Property MapPosition - Content Preposition. This behavior can be used in includes.
- content
Targeting Property MapProtection - Content Targeting is based on
EdgeScape
, Akamai's location-based access control system. You can use it to allow or deny access to a set of geographic regions or IP addresses. This behavior can be used in includes. - cors
Support Property Map - Cross-origin resource sharing (CORS) allows web pages in one domain to access restricted resources from your domain. Specify external origin hostnames, methods, and headers that you want to accept via HTTP response headers. Full support of CORS requires allowing requests that use the OPTIONS method. See
allowOptions
. This behavior can be used in includes. - cp
Code Property Map - Content Provider Codes (CP codes) allow you to distinguish various reporting and billing traffic segments, and you need them to access properties. You receive an initial CP code when purchasing Akamai, and you can run the
Create a new CP code
operation to generate more. This behavior applies any valid CP code, either as required as a default at the top of the rule tree, or subsequently to override the default. For a CP code to be valid, it needs to be assigned the same contract and product as the property, and the group needs access to it. For available values, run theList CP codes
operation. This behavior can be used in includes. - custom
Behavior Property Map - Allows you to insert a customized XML metadata behavior into any property's rule tree. Talk to your Akamai representative to implement the customized behavior. Once it's ready, run PAPI's
List custom behaviors
operation, then apply the relevantbehaviorId
value from the response within the currentcustomBehavior
. SeeCustom behaviors and overrides
for guidance on custom metadata behaviors. This behavior can be used in includes. - datastream Property Map
- The
DataStream
reporting service provides real-time logs on application activity, including aggregated metrics on complete request and response cycles and origin response times. Apply this behavior to report on this set of traffic. Use theDataStream API
to aggregate the data. This behavior cannot be used in includes. - dcp Property Map
- The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. (TheIoT Edge Connect API
allows programmatic access.) This behavior allows you to select previously reserved namespaces and set the protocols for users to publish and receive messages within these namespaces. Use theverifyJsonWebTokenForDcp
behavior to control access. This behavior cannot be used in includes. - dcp
Auth Property MapHmac Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then generates a hash value based on the selected algorithm, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth Property MapRegex Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then transforms the string based on a regular expression search pattern, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth Property MapSubstring Transformation - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. In conjunction withdcpAuthVariableExtractor
, this behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. It transforms a source string value extracted from the client certificate and stored as a variable, then extracts a substring, for use in authenticating the client request. This behavior cannot be used in includes. - dcp
Auth Property MapVariable Extractor - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior affects how clients can authenticate themselves to edge servers, and which groups within namespaces are authorized to access topics. When enabled, this behavior allows end users to authenticate their requests with valid x509 client certificates. Either a client identifier or access authorization groups are required to make the request valid. This behavior cannot be used in includes. - dcp
Default Property MapAuthz Groups - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior defines a set of default authorization groups to add to each request the property configuration controls. These groups have access regardless of the authentication method you use, either JWT using theverifyJsonWebTokenForDcp
behavior, or mutual authentication using thedcpAuthVariableExtractor
behavior to control where authorization groups are extracted from within certificates. This behavior cannot be used in includes. - dcp
Dev Property MapRelations - The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior allows Akamai-external clients to use developer test accounts in a shared environment. In conjunction withverifyJsonWebTokenForDcp
, this behavior allows you to use your own JWTs in your requests, or those generated by Akamai. It lets you either enable the default JWT server for your test configuration by setting the authentication endpoint to a default path, or specify custom settings for your JWT server and the authentication endpoint. This behavior cannot be used in includes. - dcp
Real Property MapTime Auth - INTERNAL ONLY: The
Internet of Things: Edge Connect
product allows connected users and devices to communicate on a publish-subscribe basis within reserved namespaces. This behavior lets you configure the real time authentication to edge servers. This behavior is for internal usage only. This behavior cannot be used in includes. - delivery
Receipt Property Map - A static behavior that's required when specifying the Cloud Monitor module's (
edgeConnect
behavior. You can only apply this behavior if the property is marked as secure. SeeSecure property requirements
for guidance. This behavior can be used in includes. - deny
Access Property Map - Assuming a condition in the rule matches, this denies access to the requested content. For example, a
userLocation
match paired with this behavior would deny requests from a specified part of the world. This behavior can be used in includes. - deny
Direct Property MapFailover Access - A static behavior required for all properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- device
Characteristic Property MapCache Id - By default, source URLs serve as cache IDs on edge servers. Electronic Data Capture allows you to specify an additional set of device characteristics to generate separate cache keys. Use this in conjunction with the
deviceCharacteristicHeader
behavior. This behavior can be used in includes. - device
Characteristic Property MapHeader - Sends selected information about requesting devices to the origin server, in the form of an
X-Akamai-Device-Characteristics
HTTP header. Use in conjunction with thedeviceCharacteristicCacheId
behavior. This behavior can be used in includes. - dns
Async Property MapRefresh - Allow an edge server to use an expired DNS record when forwarding a request to your origin. The
type A
DNS record refreshesafter
content is served to the end user, so there is no wait for the DNS resolution. Avoid this behavior if you want to be able to disable a server immediately after its DNS record expires. This behavior can be used in includes. - dns
Prefresh Property Map - Allows edge servers to refresh your origin's DNS record independently from end-user requests. The
type A
DNS record refreshes before the origin's DNS record expires. This behavior is for internal usage only. This behavior can be used in includes. - downgrade
Protocol Property Map - Serve static objects to the end-user client over HTTPS, but fetch them from the origin via HTTP. This behavior cannot be used in includes.
- download
Complete Property MapMarker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior logs requests to the OTA servers as completed in aggregated and individual reports. This behavior can be used in includes. - download
Notification Property Map - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. Based on match criteria that executes a rule, this behavior allows requests to theOTA Updates API
for a list of completed downloads to individual vehicles. This behavior cannot be used in includes. - downstream
Cache Property Map - Specify the caching instructions the edge server sends to the end user's client or client proxies. By default, the cache's duration is whichever is less: the remaining lifetime of the edge cache, or what the origin's header specifies. If the origin is set to
no-store
orbypass-cache
, edge servers sendcache-busting
headers downstream to prevent downstream caching. This behavior can be used in includes. - dynamic
Throughtput Property MapOptimization - Enables
quick retry
, which detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. By default, connections under 5 mbps trigger this behavior. When the transfer rate drops below this rate during a connection attempt, quick retry is enabled and a different forward connection path is used. Contact Akamai Professional Services to override this threshold. This behavior can be used in includes. - dynamic
Throughtput Property MapOptimization Override - This overrides the default threshold of 5 Mbps that triggers the
dynamicThroughtputOptimization
behavior, which enables the quick retry feature. Quick retry detects slow forward throughput while fetching an object, and attempts a different forward connection path to avoid congestion. This behavior is for internal usage only. This behavior can be used in includes. - dynamic
Web Property MapContent - In conjunction with the
subCustomer
behavior, this optional behavior allows you to control how dynamic web content behaves for your subcustomers usingAkamai Cloud Embed
. This behavior can be used in includes. - ecms
Bulk Property MapUpload - Uploads a ZIP archive with objects to an existing data set. The target data set stores objects as key-value pairs. The path to an object in the ZIP archive is a key, and the content of an object is a value. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - ecms
Database Property Map - Edge Connect Message Store is available for
Internet of Things: Edge Connect
users. It lets you create databases and data sets within these databases. You can use this object store to save files smaller than 2 GB.ecmsDatabase
specifies a default database for requests to this property, unless indicated otherwise in the URL. To access objects in the default database, you can skip its name in the URLs. To access objects in a different database, pass its name in the header, query parameter, or a regular expression matching a URL segment. You can also configure theecmsDataset
behavior to specify a default data set for requests. This behavior cannot be used in includes. - ecms
Dataset Property Map - Specifies a default data set for requests to this property unless indicated otherwise in the URL. To access objects in this data set, you can skip the data set name in the URLs. To access objects in a different data set within a database, pass the data set name in the header, query parameter, or a regular expression pattern matching a URL segment. You can also configure the
ecmsDatabase
behavior to specify a default database for requests. This behavior cannot be used in includes. - ecms
Object Property MapKey - Defines a regular expression to match object keys in custom URLs and to access objects in a data set. You can point custom URLs to access proper values in the target data set. For an overview, see
ecmsDatabase
. This behavior cannot be used in includes. - edge
Connect Property Map - Configures traffic logs for the Cloud Monitor push API. This behavior can be used in includes.
- edge
Load Property MapBalancing Advanced - This behavior implements customized Edge Load Balancing features. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior cannot be used in includes.
- edge
Load Property MapBalancing Data Center - The Edge Load Balancing module allows you to specify groups of data centers that implement load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- edge
Load Property MapBalancing Origin - The Edge Load Balancing module allows you to implement groups of data centers featuring load balancing, session persistence, and real-time dynamic failover. Enabling ELB routes requests contextually based on location, device, or network, along with optional rules you specify. This behavior cannot be used in includes.
- Property Map
- Allows the origin server to use a cookie to ensure requests from Akamai servers are genuine. This behavior can be used in includes.
- edge
Redirector Property Map - This behavior enables the
Edge Redirector Cloudlet
application, which helps you manage large numbers of redirects. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control the Edge Redirector withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - edge
Scape Property Map EdgeScape
allows you to customize content based on the end user's geographic location or connection speed. When enabled, the edge server sends a specialX-Akamai-Edgescape
header to the origin server encoding relevant details about the end-user client as key-value pairs. This behavior can be used in includes.- edge
Side Property MapIncludes - Allows edge servers to process edge side include (ESI) code to generate dynamic content. To apply this behavior, you need to match on a
contentType
,path
, orfilename
. Since this behavior requires more parsing time, you should not apply it to pages that lack ESI code, or to any non-HTML content. This behavior can be used in includes. - edge
Worker Property Map EdgeWorkers
are JavaScript applications that allow you to manipulate your web traffic on edge servers outside of Property Manager behaviors, and deployed independently from your configuration's logic. This behavior applies an EdgeWorker to a set of edge requests. This behavior cannot be used in includes.- enhanced
Akamai Property MapProtocol - Enables the Enhanced Akamai Protocol, a suite of advanced routing and transport optimizations that increase your website's performance and reliability. It is only available to specific applications, and requires a special routing from edge to origin. This behavior can be used in includes.
- enhanced
Proxy Property MapDetection - Enhanced Proxy Detection (EPD) leverages the GeoGuard service provided by GeoComply to add proxy detection and location spoofing protection. It identifies requests for your content that have been redirected from an unwanted source through a proxy. You can then allow, deny, or redirect these requests. This behavior can be used in includes.
- epd
Forward Property MapHeader Enrichment - This behavior identifies unwanted requests from an anonymous proxy. This and the
enhancedProxyDetection
behavior work together and need to be included either in the same rule, or in the default one. This behavior can be used in includes. - fail
Action Property Map - Specifies how to respond when the origin is not available: by serving stale content, by serving an error page, or by redirecting. To apply this behavior, you should match on an
originTimeout
ormatchResponseCode
. This behavior can be used in includes. - failover
Bot Property MapManager Feature Compatibility - Ensures that functionality such as challenge authentication and reset protocol work with a failover product property you use to create an alternate hostname. Apply it to any properties that implement a failover under the Cloud Security Failover product. This behavior can be used in includes.
- fast
Invalidate Property Map - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- first
Party Property MapMarketing - Enables the Cloud Marketing Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketingPlus
behavior, which integrates better with both MediaMath and its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - first
Party Property MapMarketing Plus - Enables the Cloud Marketing Plus Cloudlet, which helps MediaMath customers collect usage data and place corresponding tags for use in online advertising. You can configure tags using either the Cloudlets Policy Manager application or the
Cloudlets API
. See also thefirstPartyMarketing
behavior, which integrates with MediaMath but not its partners. Both behaviors support the same set of options. This behavior cannot be used in includes. - forward
Rewrite Property Map - The Forward Rewrite Cloudlet allows you to conditionally modify the forward path in edge content without affecting the URL that displays in the user's address bar. If Cloudlets are available on your contract, choose
Your services
>Edge logic Cloudlets
to control how this feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - front
End Property MapOptimization - This behavior is deprecated, but you shouldn't disable or remove it if present. This behavior cannot be used in includes.
- g2oheader Property Map
- The
signature header authentication
(g2o) security feature provides header-based verification of outgoing origin requests. Edge servers encrypt request data in a pre-defined header, which the origin uses to verify that the edge server processed the request. This behavior configures the request data, header names, encryption algorithm, and shared secret to use for verification. This behavior can be used in includes. - global
Request Property MapNumber - Generates a unique identifier for each request on the Akamai edge network, for use in logging and debugging. GRN identifiers follow the same format as Akamai's error reference strings, for example:
0.05313217.1567801841.1457a3
. You can use the Edge Diagnostics API'sTranslate error string
operation to get low-level details about any request. This behavior can be used in includes. - graphql
Caching Property Map - This behavior configures how to cache GraphQL-based API traffic. Enable
caching
for your GraphQL API traffic, along withallowPost
to cache POST responses. To configure REST API traffic, use therapid
behavior. This behavior can be used in includes. - gzip
Response Property Map - Apply
gzip
compression to speed transfer time. This behavior applies best to text-based content such as HTML, CSS, and JavaScript, especially once files exceed about 10KB. Do not apply it to already compressed image formats, or to small files that would add more time to uncompress. To apply this behavior, you should match oncontentType
or the content'scacheability
. This behavior can be used in includes. - hd
Data Property MapAdvanced - This behavior specifies Akamai XML metadata that can only be configured on your behalf by Akamai Professional Services. Unlike the
advanced
behavior, this may apply a different set of overriding metadata that executes in a post-processing phase. This behavior is for internal usage only. This behavior can be used in includes. - health
Detection Property Map - Monitors the health of your origin server by tracking unsuccessful attempts to contact it. Use this behavior to keep end users from having to wait several seconds before a forwarded request times out, or to reduce requests on the origin server when it is unavailable. This behavior can be used in includes.
- hsaf
Eip Property MapBinding - Edge IP Binding works with a limited set of static IP addresses to distribute your content, which can be limiting in large footprint environments. This behavior sets Hash Serial and Forward (HSAF) for Edge IP Binding to deal with larger footprints. It can only be configured on your behalf by Akamai Professional Services. This behavior is for internal usage only. This behavior cannot be used in includes.
- http2 Property Map
- Enables the HTTP/2 protocol, which reduces latency and improves efficiency. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
for guidance. This behavior cannot be used in includes. - http3 Property Map
- This enables the HTTP/3 protocol that uses QUIC. The behavior allows for improved performance and faster connection setup. You can only apply this behavior if the property is marked as secure. See
Secure property requirements
and theProperty Manager documentation
for guidance. This behavior cannot be used in includes. - http
Strict Property MapTransport Security - Applies HTTP Strict Transport Security (HSTS), disallowing insecure HTTP traffic. Apply this to hostnames managed with Standard TLS or Enhanced TLS certificates. This behavior cannot be used in includes.
- http
To Property MapHttps Upgrade - Upgrades an HTTP edge request to HTTPS for the remainder of the request flow. Enable this behavior only if your origin supports HTTPS, and if your
origin
behavior is configured withoriginCertsToHonor
to verify SSL certificates. This behavior can be used in includes. - im
Override Property Map - This specifies common query parameters that affect how
imageManager
transforms images, potentially overriding policy, width, format, or density request parameters. This also allows you to assign the value of one of the property'srule tree variables
to one of Image and Video Manager's own policy variables. This behavior can be used in includes. - image
And Property MapVideo Manager - This behavior can be used in includes.
- image
Manager Property Map - Optimizes images' size or file type for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching images using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. Once you apply Image and Video Manager to traffic, you can add theadvancedImMatch
to ensure the behavior applies to the requests from the Image and Video Manager backend. This behavior can be used in includes. - image
Manager Property MapVideo - Optimizes videos managed by Image and Video Manager for the requesting device. You can also use this behavior to generate API tokens to apply your own policies to matching videos using the
Image and Video Manager API
. To apply this behavior, you need to match on afileExtension
. This behavior can be used in includes. - include Property Map
- Includes let you reuse chunks of a property configuration that you can manage separately from the rest of the property rule tree. This behavior cannot be used in includes.
- input
Validation Property Map - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- instant Property Map
- The Instant feature allows you to prefetch content to the edge cache by adding link relation attributes to markup. For example: This behavior can be used in includes.
- instant
Config Property Map - Multi-Domain Configuration, also known as
InstantConfig
, allows you to apply property settings to all incoming hostnames based on a DNS lookup, without explicitly listing them among the property's hostnames. This behavior cannot be used in includes. - large
File Property MapOptimization - The
Large File Optimization
(LFO) feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and you should apply it to anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files, and enable theuseVersioning
option while enforcing your own filename versioning policy. Make sure you meet all therequirements and best practices
for the LFO delivery. This behavior can be used in includes. - large
File Property MapOptimization Advanced - The
Large File Optimization
feature improves performance and reliability when delivering large files. You need this behavior for objects larger than 1.8GB, and it's recommended for anything over 100MB. You should apply it only to the specific content to be optimized, such as a download directory's.gz
files. Note that it is best to useNetStorage
for objects larger than 1.8GB. This behavior is for internal usage only. This behavior can be used in includes. - limit
Bit Property MapRate - Control the rate at which content serves out to end users, optionally varying the speed depending on the file size or elapsed download time. Each bit rate specified in the
bitrateTable
array corresponds to athresholdTable
entry that activates it. You can use this behavior to prevent media downloads from progressing faster than they are viewed, for example, or to differentiate various tiers of end-user experience. To apply this behavior, you should match on acontentType
,path
, orfilename
. This behavior can be used in includes. - log
Custom Property Map - Logs custom details from the origin response in the
Log Delivery Service
report. This behavior can be used in includes. - m
Pulse Property Map mPulse
provides high-level performance analytics and predictive recommendations based on real end user data. See themPulse Quick Start
to set up mPulse on your website. This behavior cannot be used in includes.- manifest
Personalization Property Map - Allows customers who use the Adaptive Media Delivery product to enhance content based on the capabilities of each end user's device. This behavior configures a
manifest
for both HLS Live and on-demand streaming. For more information, seeAdaptive Media Delivery
. This behavior can be used in includes. - manifest
Rerouting Property Map - This behavior works with
adScalerCircuitBreaker
. It delegates parts of the media delivery workflow, like ad insertion, to other technology partners. Akamai reroutes manifest file requests to partner platforms for processing prior to being delivered. Rerouting simplifies the workflow and improves the media streaming experience. This behavior cannot be used in includes. - manual
Server Property MapPush - With the
http2
behavior enabled, this loads a specified set of objects into the client browser's cache. To apply this behavior, you should match on apath
orfilename
. This behavior cannot be used in includes. - media
Acceleration Property Map - Enables Accelerated Media Delivery for this set of requests. This behavior cannot be used in includes.
- media
Acceleration Property MapQuic Optout - When enabled, disables use of QUIC protocol for this set of accelerated media content. This behavior cannot be used in includes.
- media
Client Property Map - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- media
File Property MapRetrieval Optimization - Media File Retrieval Optimization (MFRO) speeds the delivery of large media files by relying on caches of partial objects. You should use it for files larger than 100 MB. It's required for files larger than 1.8 GB, and works best with
NetStorage
. To apply this behavior, you should match on afileExtension
. This behavior can be used in includes. - media
Origin Property MapFailover - Specifies how edge servers respond when the origin is unresponsive, or suffers from server or content errors. You can specify how many times to retry, switch to a backup origin hostname, or configure a redirect. This behavior can be used in includes.
- metadata
Caching Property Map - This behavior reduces time spent waiting for the initial response, also known as time to first byte, during peak traffic events. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes.
- mobile
Sdk Property MapPerformance - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- modify
Incoming Property MapRequest Header - Modify, add, remove, or pass along specific request headers coming upstream from the client. This behavior can be used in includes.
- modify
Incoming Property MapResponse Header - Modify, add, remove, or pass along specific response headers coming downstream from the origin. This behavior can be used in includes.
- modify
Outgoing Property MapRequest Header - Modify, add, remove, or pass along specific request headers going upstream towards the origin. This behavior can be used in includes.
- modify
Outgoing Property MapResponse Header - Modify, add, remove, or pass along specific response headers going downstream towards the client. This behavior can be used in includes.
- modify
Via Property MapHeader - Removes or renames the HTTP
Via
headers used to inform the server of proxies through which the request was sent to the origin. This behavior can be used in includes. - origin Property Map
- Specify the hostname and settings used to contact the origin once service begins. You can use your own origin,
NetStorage
, an Edge Load Balancing origin, or a SaaS dynamic origin. This behavior can be used in includes. - origin
Characteristics Property Map - Specifies characteristics of the origin. Akamai uses this information to optimize your metadata configuration, which may result in better origin offload and end-user performance. This behavior cannot be used in includes.
- origin
Characteristics Property MapWsd - Specifies characteristics of the origin, for use in Akamai's Wholesale Delivery product. This behavior can be used in includes.
- origin
Failure Property MapRecovery Method - Origin Failover requires that you set up a separate rule containing origin failure recovery methods. You also need to set up the Origin Failure Recovery Policy behavior in a separate rule with a desired match criteria, and select the desired failover method. You can do this using Property Manager. Learn more about this process in
Adaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryPolicy
member to edit existing instances of the Origin Failure Recover Policy behavior. This behavior can be used in includes. - origin
Failure Property MapRecovery Policy - Configures how to detect an origin failure, in which case the
originFailureRecoveryMethod
behavior applies. You can also define up to three sets of criteria to detect origin failure based on specific response codes. Use it to apply specific retry or recovery actions. You can do this using Property Manager. Learn more about this process inAdaptive Media Delivery Implementation Guide
. You can use theoriginFailureRecoveryMethod
member to edit existing instances of the Origin Failure Recover Method behavior. This behavior can be used in includes. - origin
Ip Property MapAcl - Origin IP Access Control List limits the traffic to your origin. It only allows requests from specific edge servers that are configured as part of a supernet defined by CIDR blocks. This behavior can be used in includes.
- persistent
Client Property MapConnection - This behavior activates
persistent connections
between edge servers and clients, which allow for better performance and more efficient use of resources. Compare with thepersistentConnection
behavior, which configures persistent connections for the entire journey from origin to edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - persistent
Connection Property Map - This behavior enables more efficient
persistent connections
from origin to edge server to client. Compare with thepersistentClientConnection
behavior, which customizes persistent connections from edge to client. Contact Akamai Professional Services for help configuring either. This behavior is for internal usage only. This behavior can be used in includes. - personally
Identifiable Property MapInformation - Marks content covered by the current rule as sensitive
personally identifiable information
that needs to be treated as secure and private. That includes anything involving personal information: name, social security number, date and place of birth, mother's maiden name, biometric data, or any other data linked to an individual. If you attempt to save a property with such a rule that also caches or logs sensitive content, the added behavior results in a validation error. This behavior cannot be used in includes. - phased
Release Property Map - The Phased Release Cloudlet provides gradual and granular traffic management to an alternate origin in near real time. Use the
Cloudlets API
or the Cloudlets Policy Manager application withinControl Center
to set up your Cloudlets policies. This behavior cannot be used in includes. - preconnect Property Map
- With the
http2
behavior enabled, this requests a specified set of domains that relate to your property hostname, and keeps the connection open for faster loading of content from those domains. This behavior can be used in includes. - predictive
Content Property MapDelivery - Improves user experience and reduces the cost of downloads by enabling mobile devices to predictively fetch and cache content from catalogs managed by Akamai servers. You can't use this feature if in the
segmentedMediaOptimization
behavior, the value forbehavior
is set toLIVE
. This behavior can be used in includes. - predictive
Prefetching Property Map - This behavior potentially reduces the client's page load time by pre-caching objects based on historical data for the page, not just its current set of referenced objects. It also detects second-level dependencies, such as objects retrieved by JavaScript. This behavior can be used in includes.
- prefetch Property Map
- Instructs edge servers to retrieve content linked from requested pages as they load, rather than waiting for separate requests for the linked content. This behavior applies depending on the rule's set of matching conditions. Use in conjunction with the
prefetchable
behavior, which specifies the set of objects to prefetch. This behavior can be used in includes. - prefetchable Property Map
- Allow matching objects to prefetch into the edge cache as the parent page that links to them loads, rather than waiting for a direct request. This behavior applies depending on the rule's set of matching conditions. Use
prefetch
to enable the overall behavior for parent pages that contain links to the object. To apply this behavior, you need to match on afilename
orfileExtension
. This behavior can be used in includes. - prefresh
Cache Property Map - Refresh cached content before its time-to-live (TTL) expires, to keep end users from having to wait for the origin to provide fresh content. This behavior can be used in includes.
- quality Property Map
- This behavior can be used in includes.
- quic
Beta Property Map - For a share of responses, includes an
Alt-Svc
header for compatible clients to initiate subsequent sessions using the QUIC protocol. This behavior cannot be used in includes. - random
Seek Property Map - Optimizes
.flv
and.mp4
files to allow random jump-point navigation. This behavior can be used in includes. - rapid Property Map
- The
Akamai API Gateway
allows you to configure API traffic delivered over the Akamai network. Apply this behavior to a set of API assets, then use Akamai'sAPI Endpoints API
to configure how the traffic responds. Use theAPI Keys and Traffic Management API
to control access to your APIs. This behavior cannot be used in includes. - read
Timeout Property Map - This behavior specifies how long the edge server should wait for a response from the requesting forward server after a connection has already been established. This behavior can be used in includes.
- real
Time Property MapReporting - This enables Real-Time Reporting for Akamai
Cloud Embed
customers. The behavior can only be configured on your behalf by Akamai Professional Services. You can access real-time reports data for that base configuration withMedia Delivery Reports API
. This behavior is for internal usage only. This behavior can be used in includes. - real
User Property MapMonitoring - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- redirect Property Map
- Respond to the client request with a redirect without contacting the origin. Specify the redirect as a path expression starting with a
/
character relative to the current root, or as a fully qualified URL. This behavior relies primarily ondestinationHostname
anddestinationPath
to manipulate the hostname and path independently. This behavior can be used in includes. - redirectplus Property Map
- Respond to the client request with a redirect without contacting the origin. This behavior fills the same need as
redirect
, but allows you to usevariables
to express the redirectdestination
's component values more concisely. This behavior can be used in includes. - referer
Checking Property Map - Limits allowed requests to a set of domains you specify. This behavior can be used in includes.
- remove
Query Property MapParameter - Remove named query parameters before forwarding the request to the origin. This behavior can be used in includes.
- remove
Vary Property Map - By default, responses that feature a
Vary
header value of anything other thanAccept-Encoding
and a correspondingContent-Encoding: gzip
header aren't cached on edge servers.Vary
headers indicate when a URL's content varies depending on some variable, such as whichUser-Agent
requests it. This behavior simply removes theVary
header to make responses cacheable. This behavior can be used in includes. - report Property Map
- Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports. This behavior can be used in includes.
- request
Control Property Map - The Request Control Cloudlet allows you to control access to your web content based on the incoming request's IP or geographic location. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control how the feature works withinControl Center
, or use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - request
Type Property MapMarker - The
Internet of Things: OTA Updates
product allows customers to securely distribute firmware to devices over cellular networks. When using thedownloadCompleteMarker
behavior to log successful downloads, this related behavior identifies download or campaign server types in aggregated and individual reports. This behavior can be used in includes. - resource
Optimizer Property Map - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- resource
Optimizer Property MapExtended Compatibility - This enhances the standard version of the
resourceOptimizer
behavior to support the compression of additional file formats and address some compatibility issues. This behavior can be used in includes. - response
Code Property Map - Change the existing response code. For example, if your origin sends a
301
permanent redirect, this behavior can change it on the edge to a temporary302
redirect. This behavior can be used in includes. - Property Map
- Set a cookie to send downstream to the client with either a fixed value or a unique stamp. This behavior can be used in includes.
- restrict
Object Property MapCaching - You need this behavior to deploy the Object Caching product. It disables serving HTML content and limits the maximum object size to 100MB. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- return
Cache Property MapStatus - Generates a response header with information about cache status. Among other things, this can tell you whether the response came from the Akamai cache, or from the origin. Status values report with either of these forms of syntax, depending for example on whether you're deploying traffic using
sureRoute
ortieredDistribution
: This behavior can be used in includes. - rewrite
Url Property Map - Modifies the path of incoming requests to forward to the origin. This helps you offload URL-rewriting tasks to the edge to increase the origin server's performance, allows you to redirect links to different targets without changing markup, and hides your original directory structure. This behavior can be used in includes.
- rum
Custom Property Map - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- saas
Definitions Property Map - Configures how the Software as a Service feature identifies
customers
,applications
, andusers
. A different set of options is available for each type of targeted request, each enabled with theaction
-suffixed option. In each case, you can usePATH
,COOKIE
,QUERY_STRING
, orHOSTNAME
components as identifiers, ordisable
the SaaS behavior for certain targets. If you rely on aHOSTNAME
, you also have the option of specifying aCNAME chain
rather than an individual hostname. The various options suffixedregex
andreplace
subsequently remove the identifier from the request. This behavior requires a siblingorigin
behavior whoseoriginType
option is set toSAAS_DYNAMIC_ORIGIN
. This behavior cannot be used in includes. - sales
Force Property MapCommerce Cloud Client - If you use the Salesforce Commerce Cloud platform for your origin content, this behavior allows your edge content managed by Akamai to contact directly to origin. This behavior cannot be used in includes.
- sales
Force Property MapCommerce Cloud Provider - This manages traffic between mutual customers and the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- sales
Force Property MapCommerce Cloud Provider Host Header - Manages host header values sent to the Salesforce Commerce Cloud platform. This behavior cannot be used in includes.
- save
Post Property MapDca Processing - Used in conjunction with the
cachePost
behavior, this behavior allows the body of POST requests to be processed through Dynamic Content Assembly. Contact Akamai Professional Services for help configuring it. This behavior is for internal usage only. This behavior can be used in includes. - schedule
Invalidation Property Map - Specifies when cached content that satisfies a rule's criteria expires, optionally at repeating intervals. In addition to periodic cache flushes, you can use this behavior to minimize potential conflicts when related objects expire at different times. This behavior can be used in includes.
- script
Management Property Map - Ensures unresponsive linked JavaScript files do not prevent HTML pages from loading. See
Script Management API
for more information. This behavior cannot be used in includes. - segmented
Content Property MapProtection - Validates authorization tokens at the edge server to prevent unauthorized link sharing. This behavior can be used in includes.
- segmented
Media Property MapOptimization - Optimizes segmented media for live or streaming delivery contexts. This behavior can be used in includes.
- segmented
Media Property MapStreaming Prefetch - Prefetches HLS and DASH media stream manifest and segment files, accelerating delivery to end users. For prefetching to work, your origin media's response needs to specify
CDN-Origin-Assist-Prefetch-Path
headers with each URL to prefetch, expressed as either a relative or absolute path. This behavior can be used in includes. - set
Variable Property Map - Modify a variable to insert into subsequent fields within the rule tree. Use this behavior to specify the predeclared
variableName
and determine from where to derive its new value. Based on thisvalueSource
, you can either generate the value, extract it from some part of the incoming request, assign it from another variable (including a set of built-in system variables), or directly specify its text. Optionally choose atransform
function to modify the value once. SeeSupport for variables
for more information. This behavior can be used in includes. - shutr Property Map
- This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- simulate
Error Property MapCode - This behavior simulates various error response codes. Contact Akamai Professional Services for help configuring it. This behavior can be used in includes.
- site
Shield Property Map - This behavior implements the
Site Shield
feature, which helps prevent non-Akamai machines from contacting your origin. You get an email with a list of Akamai servers allowed to contact your origin, with which you establish an Access Control List on your firewall to prevent any other requests. This behavior cannot be used in includes. - standard
Tls Property MapMigration - This behavior is deprecated, but you should not disable or remove it if present. This behavior cannot be used in includes.
- standard
Tls Property MapMigration Override - This behavior is deprecated, but you should not disable or remove it if present. This behavior is for internal usage only. This behavior cannot be used in includes.
- strict
Header Property MapParsing - This behavior specifies how the edge servers should handle requests containing improperly formatted or invalid headers that don’t comply with
RFC 9110
. This behavior can be used in includes. - sub
Customer Property Map - When positioned in a property's top-level default rule, enables various
Cloud Embed
features that allow you to leverage Akamai's CDN architecture for your own subcustomers. This behavior's options allow you to use Cloud Embed to configure your subcustomers' content. Once enabled, you can use theAkamai Cloud Embed API
(ACE) to assign subcustomers to this base configuration, and to customize policies for them. See also thedynamicWebContent
behavior to configure subcustomers' dynamic web content. This behavior cannot be used in includes. - sure
Route Property Map - The
SureRoute
feature continually tests different routes between origin and edge servers to identify the optimal path. By default, it conductsraces
to identify alternative paths to use in case of a transmission failure. These races increase origin traffic slightly. This behavior cannot be used in includes. - tcp
Optimization Property Map - This behavior is deprecated, but you should not disable or remove it if present. This behavior can be used in includes.
- tea
Leaf Property Map - Allows IBM Tealeaf Customer Experience on Cloud to record HTTPS requests and responses for Akamai-enabled properties. Recorded data becomes available in your IBM Tealeaf account. This behavior cannot be used in includes.
- tiered
Distribution Property Map - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This behavior cannot be used in includes. - tiered
Distribution Property MapAdvanced - This behavior allows Akamai edge servers to retrieve cached content from other Akamai servers, rather than directly from the origin. These interim
parent
servers in thecache hierarchy
(CH
) are positioned close to the origin, and fall along the path from the origin to the edge server. Tiered Distribution typically reduces the origin server's load, and reduces the time it takes for edge servers to refresh content. This advanced behavior provides a wider set of options thantieredDistribution
. This behavior is for internal usage only. This behavior can be used in includes. - tiered
Distribution Property MapCustomization - With Tiered Distribution, Akamai edge servers retrieve cached content from other Akamai servers, rather than directly from the origin. This behavior sets custom Tiered Distribution maps (TD0) and migrates TD1 maps configured with
advanced features
to Cloud Wrapper. You need to enablecloudWrapper
within the same rule. This behavior is for internal usage only. This behavior can be used in includes. - timeout Property Map
- Sets the HTTP connect timeout. This behavior can be used in includes.
- uid
Configuration Property Map - This behavior allows you to extract unique identifier (UID) values from live traffic, for use in OTA applications. Note that you are responsible for maintaining the security of any data that may identify individual users. This behavior cannot be used in includes.
- validate
Entity Property MapTag - Instructs edge servers to compare the request's
ETag
header with that of the cached object. If they differ, the edge server sends a new copy of the object. This validation occurs in addition to the default validation ofLast-Modified
andIf-Modified-Since
headers. This behavior can be used in includes. - verify
Json Property MapWeb Token - This behavior allows you to use JSON Web Tokens (JWT) to verify requests. This behavior can be used in includes.
- verify
Json Property MapWeb Token For Dcp - This behavior allows you to use JSON web tokens (JWT) to verify requests for use in implementing
IoT Edge Connect
, which you use thedcp
behavior to configure. You can specify the location in a request to pass a JSON web token (JWT), collections of public keys to verify the integrity of this token, and specific claims to extract from it. Use theverifyJsonWebToken
behavior for other JWT validation. This behavior can be used in includes. - Property Map
- Verifies Auth 2.0 tokens. This behavior can be used in includes.
- virtual
Waiting Property MapRoom - This behavior helps you maintain business continuity for dynamic applications in high-demand situations such as flash sales. It decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a request processing mechanism that prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, choose
Your services
>Edge logic Cloudlets
to control Virtual Waitig Room withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. This behavior cannot be used in includes. - virtual
Waiting Property MapRoom With Edge Workers - This behavior allows you to configure the
virtualWaitingRoom
behavior with EdgeWorkers for extended scalability and customization. This behavior cannot be used in includes. - visitor
Prioritization Property Map - The
Visitor Prioritization Cloudlet
decreases abandonment by providing a user-friendly waiting room experience. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - visitor
Prioritization Property MapFifo - (BETA) The
Visitor Prioritization Cloudlet (FIFO)
decreases abandonment by providing a user-friendly waiting room experience. FIFO (First-in First-out) is a fair request processing mechanism, which prioritizes the first requests that enter the waiting room to send them first to the origin. Users can see both their estimated arrival time and position in the line. With Cloudlets available on your contract, chooseYour services
>Edge logic Cloudlets
to control Visitor Prioritization (FIFO) withinControl Center
. Otherwise use theCloudlets API
to configure it programmatically. To serve non-HTML API content such as JSON blocks, see theapiPrioritization
behavior. This behavior cannot be used in includes. - visitor
Prioritization Property MapFifo Standalone - This behavior cannot be used in includes.
- watermarking Property Map
- Adds watermarking for each valid user's content. Content segments are delivered from different sources using a pattern unique to each user, based on a watermarking token included in each request. If your content is pirated or redistributed, you can forensically analyze the segments to extract the pattern, and identify the user who leaked the content. This behavior can be used in includes.
- web
Application Property MapFirewall - This behavior implements a suite of security features that blocks threatening HTTP and HTTPS requests. Use it as your primary firewall, or in addition to existing security measures. Only one referenced configuration is allowed per property, so this behavior typically belongs as part of its default rule. This behavior cannot be used in includes.
- web
Sockets Property Map - The WebSocket protocol allows web applications real-time bidirectional communication between clients and servers. This behavior can be used in includes.
- webdav Property Map
- Web-based Distributed Authoring and Versioning (WebDAV) is a set of extensions to the HTTP protocol that allows users to collaboratively edit and manage files on remote web servers. This behavior enables WebDAV, and provides support for the following additional request methods: PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. To apply this behavior, you need to match on a
requestMethod
. This behavior can be used in includes.
GetPropertyRulesBuilderRulesV20230105BehaviorAdScalerCircuitBreaker
- Fallback
Action stringResponse Code Based - Specifies the fallback action.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Response
Code boolBased - Triggers a fallback action based on the response code from the technology partner's server.
- Response
Codes string - Specifies the codes in the partner's response that trigger the fallback action, either
408
,500
,502
,504
,SAME_AS_RECEIEVED
, orSPECIFY_YOUR_OWN
for a custom code. - Response
Delay boolBased - Triggers a fallback action based on the delayed response from the technology partner's server.
- Response
Delay stringThreshold - Specifies the maximum response delay that, if exceeded, triggers the fallback action.
- Return
Error stringResponse Code Based - Specifies the error to include in the response to the client.
- Specify
Your stringOwn Response Code Based - Defines a custom error response.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Fallback
Action stringResponse Code Based - Specifies the fallback action.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Response
Code boolBased - Triggers a fallback action based on the response code from the technology partner's server.
- Response
Codes string - Specifies the codes in the partner's response that trigger the fallback action, either
408
,500
,502
,504
,SAME_AS_RECEIEVED
, orSPECIFY_YOUR_OWN
for a custom code. - Response
Delay boolBased - Triggers a fallback action based on the delayed response from the technology partner's server.
- Response
Delay stringThreshold - Specifies the maximum response delay that, if exceeded, triggers the fallback action.
- Return
Error stringResponse Code Based - Specifies the error to include in the response to the client.
- Specify
Your stringOwn Response Code Based - Defines a custom error response.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- fallback
Action StringResponse Code Based - Specifies the fallback action.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- response
Code BooleanBased - Triggers a fallback action based on the response code from the technology partner's server.
- response
Codes String - Specifies the codes in the partner's response that trigger the fallback action, either
408
,500
,502
,504
,SAME_AS_RECEIEVED
, orSPECIFY_YOUR_OWN
for a custom code. - response
Delay BooleanBased - Triggers a fallback action based on the delayed response from the technology partner's server.
- response
Delay StringThreshold - Specifies the maximum response delay that, if exceeded, triggers the fallback action.
- return
Error StringResponse Code Based - Specifies the error to include in the response to the client.
- specify
Your StringOwn Response Code Based - Defines a custom error response.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- fallback
Action stringResponse Code Based - Specifies the fallback action.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- response
Code booleanBased - Triggers a fallback action based on the response code from the technology partner's server.
- response
Codes string - Specifies the codes in the partner's response that trigger the fallback action, either
408
,500
,502
,504
,SAME_AS_RECEIEVED
, orSPECIFY_YOUR_OWN
for a custom code. - response
Delay booleanBased - Triggers a fallback action based on the delayed response from the technology partner's server.
- response
Delay stringThreshold - Specifies the maximum response delay that, if exceeded, triggers the fallback action.
- return
Error stringResponse Code Based - Specifies the error to include in the response to the client.
- specify
Your stringOwn Response Code Based - Defines a custom error response.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- fallback_
action_ strresponse_ code_ based - Specifies the fallback action.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- response_
code_ boolbased - Triggers a fallback action based on the response code from the technology partner's server.
- response_
codes str - Specifies the codes in the partner's response that trigger the fallback action, either
408
,500
,502
,504
,SAME_AS_RECEIEVED
, orSPECIFY_YOUR_OWN
for a custom code. - response_
delay_ boolbased - Triggers a fallback action based on the delayed response from the technology partner's server.
- response_
delay_ strthreshold - Specifies the maximum response delay that, if exceeded, triggers the fallback action.
- return_
error_ strresponse_ code_ based - Specifies the error to include in the response to the client.
- specify_
your_ strown_ response_ code_ based - Defines a custom error response.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- fallback
Action StringResponse Code Based - Specifies the fallback action.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- response
Code BooleanBased - Triggers a fallback action based on the response code from the technology partner's server.
- response
Codes String - Specifies the codes in the partner's response that trigger the fallback action, either
408
,500
,502
,504
,SAME_AS_RECEIEVED
, orSPECIFY_YOUR_OWN
for a custom code. - response
Delay BooleanBased - Triggers a fallback action based on the delayed response from the technology partner's server.
- response
Delay StringThreshold - Specifies the maximum response delay that, if exceeded, triggers the fallback action.
- return
Error StringResponse Code Based - Specifies the error to include in the response to the client.
- specify
Your StringOwn Response Code Based - Defines a custom error response.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveAcceleration
- Ab
Logic string - Specifies whether to use Adaptive Acceleration in an A/B testing environment. To include Adaptive Acceleration data in your A/B testing, specify the mode you want to apply. Otherwise,
DISABLED
by default. SeeAdd A/B testing to A2
for details. - Ab
Testing string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Compression string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- string
- This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
- Enable
Brotli boolCompression - Applies Brotli compression, converting your origin content to cache on edge servers.
- Enable
For boolNoncacheable - Applies Brotli compression to non-cacheable content.
- Enable
Preconnect bool - Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See
Automatic Preconnect
for more information. - Enable
Push bool - Recognizes resources like JavaScript, CSS, and images based on gathered timing data and sends these resources to a browser as it's waiting for a response to the initial request for your website or app. See
Automatic Server Push
for more information. - Enable
Ro bool - Enables the Resource Optimizer, which automates the compression and delivery of your
.css
,.js
, and.svg
content using a combination of Brotli and Zopfli compressions. The compression is performed offline, during a time to live that the feature automatically sets. See theresourceOptimizer
andresourceOptimizerExtendedCompatibility
behaviors for more details. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Preload
Enable bool - Allows browsers to preload necessary fonts before they fetch and process other resources. See
Automatic Font Preload
for more information. - Source string
- The source Adaptive Acceleration uses to gather the real user monitoring timing data, either
mPulse
orrealUserMonitoring
. The recommendedmPulse
option supports all optimizations and requires themPulse
behavior added by default to new Ion properties. The classicrealUserMonitoring
method has been deprecated. If you set it as the data source, make sure you use it with therealUserMonitoring
behavior. - Template
Uuid string - This option is for internal usage only.
- Title
Brotli string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Http2Server stringPush - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Preconnect string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Preload string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Ro string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Ab
Logic string - Specifies whether to use Adaptive Acceleration in an A/B testing environment. To include Adaptive Acceleration data in your A/B testing, specify the mode you want to apply. Otherwise,
DISABLED
by default. SeeAdd A/B testing to A2
for details. - Ab
Testing string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Compression string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- string
- This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
- Enable
Brotli boolCompression - Applies Brotli compression, converting your origin content to cache on edge servers.
- Enable
For boolNoncacheable - Applies Brotli compression to non-cacheable content.
- Enable
Preconnect bool - Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See
Automatic Preconnect
for more information. - Enable
Push bool - Recognizes resources like JavaScript, CSS, and images based on gathered timing data and sends these resources to a browser as it's waiting for a response to the initial request for your website or app. See
Automatic Server Push
for more information. - Enable
Ro bool - Enables the Resource Optimizer, which automates the compression and delivery of your
.css
,.js
, and.svg
content using a combination of Brotli and Zopfli compressions. The compression is performed offline, during a time to live that the feature automatically sets. See theresourceOptimizer
andresourceOptimizerExtendedCompatibility
behaviors for more details. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Preload
Enable bool - Allows browsers to preload necessary fonts before they fetch and process other resources. See
Automatic Font Preload
for more information. - Source string
- The source Adaptive Acceleration uses to gather the real user monitoring timing data, either
mPulse
orrealUserMonitoring
. The recommendedmPulse
option supports all optimizations and requires themPulse
behavior added by default to new Ion properties. The classicrealUserMonitoring
method has been deprecated. If you set it as the data source, make sure you use it with therealUserMonitoring
behavior. - Template
Uuid string - This option is for internal usage only.
- Title
Brotli string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Http2Server stringPush - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Preconnect string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Preload string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Ro string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- ab
Logic String - Specifies whether to use Adaptive Acceleration in an A/B testing environment. To include Adaptive Acceleration data in your A/B testing, specify the mode you want to apply. Otherwise,
DISABLED
by default. SeeAdd A/B testing to A2
for details. - ab
Testing String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- compression String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- String
- This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
- enable
Brotli BooleanCompression - Applies Brotli compression, converting your origin content to cache on edge servers.
- enable
For BooleanNoncacheable - Applies Brotli compression to non-cacheable content.
- enable
Preconnect Boolean - Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See
Automatic Preconnect
for more information. - enable
Push Boolean - Recognizes resources like JavaScript, CSS, and images based on gathered timing data and sends these resources to a browser as it's waiting for a response to the initial request for your website or app. See
Automatic Server Push
for more information. - enable
Ro Boolean - Enables the Resource Optimizer, which automates the compression and delivery of your
.css
,.js
, and.svg
content using a combination of Brotli and Zopfli compressions. The compression is performed offline, during a time to live that the feature automatically sets. See theresourceOptimizer
andresourceOptimizerExtendedCompatibility
behaviors for more details. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- preload
Enable Boolean - Allows browsers to preload necessary fonts before they fetch and process other resources. See
Automatic Font Preload
for more information. - source String
- The source Adaptive Acceleration uses to gather the real user monitoring timing data, either
mPulse
orrealUserMonitoring
. The recommendedmPulse
option supports all optimizations and requires themPulse
behavior added by default to new Ion properties. The classicrealUserMonitoring
method has been deprecated. If you set it as the data source, make sure you use it with therealUserMonitoring
behavior. - template
Uuid String - This option is for internal usage only.
- title
Brotli String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Http2Server StringPush - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Preconnect String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Preload String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Ro String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- ab
Logic string - Specifies whether to use Adaptive Acceleration in an A/B testing environment. To include Adaptive Acceleration data in your A/B testing, specify the mode you want to apply. Otherwise,
DISABLED
by default. SeeAdd A/B testing to A2
for details. - ab
Testing string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- compression string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- string
- This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
- enable
Brotli booleanCompression - Applies Brotli compression, converting your origin content to cache on edge servers.
- enable
For booleanNoncacheable - Applies Brotli compression to non-cacheable content.
- enable
Preconnect boolean - Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See
Automatic Preconnect
for more information. - enable
Push boolean - Recognizes resources like JavaScript, CSS, and images based on gathered timing data and sends these resources to a browser as it's waiting for a response to the initial request for your website or app. See
Automatic Server Push
for more information. - enable
Ro boolean - Enables the Resource Optimizer, which automates the compression and delivery of your
.css
,.js
, and.svg
content using a combination of Brotli and Zopfli compressions. The compression is performed offline, during a time to live that the feature automatically sets. See theresourceOptimizer
andresourceOptimizerExtendedCompatibility
behaviors for more details. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- preload
Enable boolean - Allows browsers to preload necessary fonts before they fetch and process other resources. See
Automatic Font Preload
for more information. - source string
- The source Adaptive Acceleration uses to gather the real user monitoring timing data, either
mPulse
orrealUserMonitoring
. The recommendedmPulse
option supports all optimizations and requires themPulse
behavior added by default to new Ion properties. The classicrealUserMonitoring
method has been deprecated. If you set it as the data source, make sure you use it with therealUserMonitoring
behavior. - template
Uuid string - This option is for internal usage only.
- title
Brotli string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Http2Server stringPush - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Preconnect string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Preload string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Ro string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- ab_
logic str - Specifies whether to use Adaptive Acceleration in an A/B testing environment. To include Adaptive Acceleration data in your A/B testing, specify the mode you want to apply. Otherwise,
DISABLED
by default. SeeAdd A/B testing to A2
for details. - ab_
testing str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- compression str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- str
- This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
- enable_
brotli_ boolcompression - Applies Brotli compression, converting your origin content to cache on edge servers.
- enable_
for_ boolnoncacheable - Applies Brotli compression to non-cacheable content.
- enable_
preconnect bool - Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See
Automatic Preconnect
for more information. - enable_
push bool - Recognizes resources like JavaScript, CSS, and images based on gathered timing data and sends these resources to a browser as it's waiting for a response to the initial request for your website or app. See
Automatic Server Push
for more information. - enable_
ro bool - Enables the Resource Optimizer, which automates the compression and delivery of your
.css
,.js
, and.svg
content using a combination of Brotli and Zopfli compressions. The compression is performed offline, during a time to live that the feature automatically sets. See theresourceOptimizer
andresourceOptimizerExtendedCompatibility
behaviors for more details. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- preload_
enable bool - Allows browsers to preload necessary fonts before they fetch and process other resources. See
Automatic Font Preload
for more information. - source str
- The source Adaptive Acceleration uses to gather the real user monitoring timing data, either
mPulse
orrealUserMonitoring
. The recommendedmPulse
option supports all optimizations and requires themPulse
behavior added by default to new Ion properties. The classicrealUserMonitoring
method has been deprecated. If you set it as the data source, make sure you use it with therealUserMonitoring
behavior. - template_
uuid str - This option is for internal usage only.
- title_
brotli str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title_
http2_ strserver_ push - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title_
preconnect str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title_
preload str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title_
ro str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- ab
Logic String - Specifies whether to use Adaptive Acceleration in an A/B testing environment. To include Adaptive Acceleration data in your A/B testing, specify the mode you want to apply. Otherwise,
DISABLED
by default. SeeAdd A/B testing to A2
for details. - ab
Testing String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- compression String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- String
- This specifies the name of the cookie file used for redirecting the requests in the A/B testing environment.
- enable
Brotli BooleanCompression - Applies Brotli compression, converting your origin content to cache on edge servers.
- enable
For BooleanNoncacheable - Applies Brotli compression to non-cacheable content.
- enable
Preconnect Boolean - Allows browsers to anticipate what connections your site needs, and establishes those connections ahead of time. See
Automatic Preconnect
for more information. - enable
Push Boolean - Recognizes resources like JavaScript, CSS, and images based on gathered timing data and sends these resources to a browser as it's waiting for a response to the initial request for your website or app. See
Automatic Server Push
for more information. - enable
Ro Boolean - Enables the Resource Optimizer, which automates the compression and delivery of your
.css
,.js
, and.svg
content using a combination of Brotli and Zopfli compressions. The compression is performed offline, during a time to live that the feature automatically sets. See theresourceOptimizer
andresourceOptimizerExtendedCompatibility
behaviors for more details. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- preload
Enable Boolean - Allows browsers to preload necessary fonts before they fetch and process other resources. See
Automatic Font Preload
for more information. - source String
- The source Adaptive Acceleration uses to gather the real user monitoring timing data, either
mPulse
orrealUserMonitoring
. The recommendedmPulse
option supports all optimizations and requires themPulse
behavior added by default to new Ion properties. The classicrealUserMonitoring
method has been deprecated. If you set it as the data source, make sure you use it with therealUserMonitoring
behavior. - template
Uuid String - This option is for internal usage only.
- title
Brotli String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Http2Server StringPush - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Preconnect String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Preload String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Ro String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAdaptiveImageCompression
- Compress
Mobile bool - Adapts images served over cellular mobile networks.
- Compress
Standard bool - Adapts images served over non-cellular networks.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Tier1Mobile
Compression stringMethod - Specifies tier-1 behavior.
- Tier1Mobile
Compression intValue - Specifies the compression percentage.
- Tier1Standard
Compression stringMethod - Specifies tier-1 non-cellular network behavior.
- Tier1Standard
Compression intValue - Specifies the compression percentage.
- Tier2Mobile
Compression stringMethod - Specifies tier-2 cellular-network behavior.
- Tier2Mobile
Compression intValue - Specifies the compression percentage.
- Tier2Standard
Compression stringMethod - Specifies tier-2 non-cellular network behavior.
- Tier2Standard
Compression intValue - Specifies the compression percentage.
- Tier3Mobile
Compression stringMethod - Specifies tier-3 cellular-network behavior.
- Tier3Mobile
Compression intValue - Specifies the compression percentage.
- Tier3Standard
Compression stringMethod - Specifies tier-3 non-cellular network behavior.
- Tier3Standard
Compression intValue - Specifies the compression percentage.
- Title
Aic stringMobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Aic stringNonmobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Compress
Mobile bool - Adapts images served over cellular mobile networks.
- Compress
Standard bool - Adapts images served over non-cellular networks.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Tier1Mobile
Compression stringMethod - Specifies tier-1 behavior.
- Tier1Mobile
Compression intValue - Specifies the compression percentage.
- Tier1Standard
Compression stringMethod - Specifies tier-1 non-cellular network behavior.
- Tier1Standard
Compression intValue - Specifies the compression percentage.
- Tier2Mobile
Compression stringMethod - Specifies tier-2 cellular-network behavior.
- Tier2Mobile
Compression intValue - Specifies the compression percentage.
- Tier2Standard
Compression stringMethod - Specifies tier-2 non-cellular network behavior.
- Tier2Standard
Compression intValue - Specifies the compression percentage.
- Tier3Mobile
Compression stringMethod - Specifies tier-3 cellular-network behavior.
- Tier3Mobile
Compression intValue - Specifies the compression percentage.
- Tier3Standard
Compression stringMethod - Specifies tier-3 non-cellular network behavior.
- Tier3Standard
Compression intValue - Specifies the compression percentage.
- Title
Aic stringMobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Title
Aic stringNonmobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- compress
Mobile Boolean - Adapts images served over cellular mobile networks.
- compress
Standard Boolean - Adapts images served over non-cellular networks.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- tier1Mobile
Compression StringMethod - Specifies tier-1 behavior.
- tier1Mobile
Compression IntegerValue - Specifies the compression percentage.
- tier1Standard
Compression StringMethod - Specifies tier-1 non-cellular network behavior.
- tier1Standard
Compression IntegerValue - Specifies the compression percentage.
- tier2Mobile
Compression StringMethod - Specifies tier-2 cellular-network behavior.
- tier2Mobile
Compression IntegerValue - Specifies the compression percentage.
- tier2Standard
Compression StringMethod - Specifies tier-2 non-cellular network behavior.
- tier2Standard
Compression IntegerValue - Specifies the compression percentage.
- tier3Mobile
Compression StringMethod - Specifies tier-3 cellular-network behavior.
- tier3Mobile
Compression IntegerValue - Specifies the compression percentage.
- tier3Standard
Compression StringMethod - Specifies tier-3 non-cellular network behavior.
- tier3Standard
Compression IntegerValue - Specifies the compression percentage.
- title
Aic StringMobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Aic StringNonmobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- compress
Mobile boolean - Adapts images served over cellular mobile networks.
- compress
Standard boolean - Adapts images served over non-cellular networks.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- tier1Mobile
Compression stringMethod - Specifies tier-1 behavior.
- tier1Mobile
Compression numberValue - Specifies the compression percentage.
- tier1Standard
Compression stringMethod - Specifies tier-1 non-cellular network behavior.
- tier1Standard
Compression numberValue - Specifies the compression percentage.
- tier2Mobile
Compression stringMethod - Specifies tier-2 cellular-network behavior.
- tier2Mobile
Compression numberValue - Specifies the compression percentage.
- tier2Standard
Compression stringMethod - Specifies tier-2 non-cellular network behavior.
- tier2Standard
Compression numberValue - Specifies the compression percentage.
- tier3Mobile
Compression stringMethod - Specifies tier-3 cellular-network behavior.
- tier3Mobile
Compression numberValue - Specifies the compression percentage.
- tier3Standard
Compression stringMethod - Specifies tier-3 non-cellular network behavior.
- tier3Standard
Compression numberValue - Specifies the compression percentage.
- title
Aic stringMobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Aic stringNonmobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- compress_
mobile bool - Adapts images served over cellular mobile networks.
- compress_
standard bool - Adapts images served over non-cellular networks.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- tier1_
mobile_ strcompression_ method - Specifies tier-1 behavior.
- tier1_
mobile_ intcompression_ value - Specifies the compression percentage.
- tier1_
standard_ strcompression_ method - Specifies tier-1 non-cellular network behavior.
- tier1_
standard_ intcompression_ value - Specifies the compression percentage.
- tier2_
mobile_ strcompression_ method - Specifies tier-2 cellular-network behavior.
- tier2_
mobile_ intcompression_ value - Specifies the compression percentage.
- tier2_
standard_ strcompression_ method - Specifies tier-2 non-cellular network behavior.
- tier2_
standard_ intcompression_ value - Specifies the compression percentage.
- tier3_
mobile_ strcompression_ method - Specifies tier-3 cellular-network behavior.
- tier3_
mobile_ intcompression_ value - Specifies the compression percentage.
- tier3_
standard_ strcompression_ method - Specifies tier-3 non-cellular network behavior.
- tier3_
standard_ intcompression_ value - Specifies the compression percentage.
- title_
aic_ strmobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title_
aic_ strnonmobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- compress
Mobile Boolean - Adapts images served over cellular mobile networks.
- compress
Standard Boolean - Adapts images served over non-cellular networks.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- tier1Mobile
Compression StringMethod - Specifies tier-1 behavior.
- tier1Mobile
Compression NumberValue - Specifies the compression percentage.
- tier1Standard
Compression StringMethod - Specifies tier-1 non-cellular network behavior.
- tier1Standard
Compression NumberValue - Specifies the compression percentage.
- tier2Mobile
Compression StringMethod - Specifies tier-2 cellular-network behavior.
- tier2Mobile
Compression NumberValue - Specifies the compression percentage.
- tier2Standard
Compression StringMethod - Specifies tier-2 non-cellular network behavior.
- tier2Standard
Compression NumberValue - Specifies the compression percentage.
- tier3Mobile
Compression StringMethod - Specifies tier-3 cellular-network behavior.
- tier3Mobile
Compression NumberValue - Specifies the compression percentage.
- tier3Standard
Compression StringMethod - Specifies tier-3 non-cellular network behavior.
- tier3Standard
Compression NumberValue - Specifies the compression percentage.
- title
Aic StringMobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- title
Aic StringNonmobile - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAdvanced
- Description string
- Human-readable description of what the XML block does.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Xml string
- Akamai XML metadata.
- Description string
- Human-readable description of what the XML block does.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Xml string
- Akamai XML metadata.
- description String
- Human-readable description of what the XML block does.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml String
- Akamai XML metadata.
- description string
- Human-readable description of what the XML block does.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml string
- Akamai XML metadata.
- description str
- Human-readable description of what the XML block does.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml str
- Akamai XML metadata.
- description String
- Human-readable description of what the XML block does.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml String
- Akamai XML metadata.
GetPropertyRulesBuilderRulesV20230105BehaviorAggregatedReporting
- Attribute1 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- Attribute2 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- Attribute3 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- Attribute4 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- Attributes
Count int - The number of attributes to include in the report, ranging from 1 to 4.
- Enabled bool
- Enables aggregated reporting.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Report
Name 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.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Attribute1 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- Attribute2 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- Attribute3 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- Attribute4 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- Attributes
Count int - The number of attributes to include in the report, ranging from 1 to 4.
- Enabled bool
- Enables aggregated reporting.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Report
Name 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.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- attribute1 String
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute2 String
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute3 String
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute4 String
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attributes
Count Integer - The number of attributes to include in the report, ranging from 1 to 4.
- enabled Boolean
- Enables aggregated reporting.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- report
Name 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.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- attribute1 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute2 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute3 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute4 string
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attributes
Count number - The number of attributes to include in the report, ranging from 1 to 4.
- enabled boolean
- Enables aggregated reporting.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- report
Name 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.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- attribute1 str
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute2 str
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute3 str
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute4 str
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attributes_
count int - The number of attributes to include in the report, ranging from 1 to 4.
- enabled bool
- Enables aggregated reporting.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- report_
name str - 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.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- attribute1 String
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute2 String
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute3 String
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attribute4 String
- Specify a previously user-defined variable name as a report attribute. The values extracted for all attributes range from 0 to 20 characters.
- attributes
Count Number - The number of attributes to include in the report, ranging from 1 to 4.
- enabled Boolean
- Enables aggregated reporting.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- report
Name 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.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizer
- Enabled bool
- Enables the Akamaizer behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the Akamaizer behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Akamaizer behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the Akamaizer behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the Akamaizer behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Akamaizer behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAkamaizerTag
- bool
- Whether to include the
tagsAttribute
value. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Match
Hostname string - Specifies the hostname to match on as a Perl-compatible regular expression.
- Replace
All bool - Replaces all matches when enabled, otherwise replaces only the first match.
- Replacement
Hostname string - Specifies the replacement hostname for the tag to use.
- Scope string
- Specifies the part of HTML content the
tagsAttribute
refers to. - string
- Specifies the tag or tag/attribute combination to operate on.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- bool
- Whether to include the
tagsAttribute
value. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Match
Hostname string - Specifies the hostname to match on as a Perl-compatible regular expression.
- Replace
All bool - Replaces all matches when enabled, otherwise replaces only the first match.
- Replacement
Hostname string - Specifies the replacement hostname for the tag to use.
- Scope string
- Specifies the part of HTML content the
tagsAttribute
refers to. - string
- Specifies the tag or tag/attribute combination to operate on.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Boolean
- Whether to include the
tagsAttribute
value. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Hostname String - Specifies the hostname to match on as a Perl-compatible regular expression.
- replace
All Boolean - Replaces all matches when enabled, otherwise replaces only the first match.
- replacement
Hostname String - Specifies the replacement hostname for the tag to use.
- scope String
- Specifies the part of HTML content the
tagsAttribute
refers to. - String
- Specifies the tag or tag/attribute combination to operate on.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- boolean
- Whether to include the
tagsAttribute
value. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Hostname string - Specifies the hostname to match on as a Perl-compatible regular expression.
- replace
All boolean - Replaces all matches when enabled, otherwise replaces only the first match.
- replacement
Hostname string - Specifies the replacement hostname for the tag to use.
- scope string
- Specifies the part of HTML content the
tagsAttribute
refers to. - string
- Specifies the tag or tag/attribute combination to operate on.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- bool
- Whether to include the
tagsAttribute
value. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match_
hostname str - Specifies the hostname to match on as a Perl-compatible regular expression.
- replace_
all bool - Replaces all matches when enabled, otherwise replaces only the first match.
- replacement_
hostname str - Specifies the replacement hostname for the tag to use.
- scope str
- Specifies the part of HTML content the
tagsAttribute
refers to. - str
- Specifies the tag or tag/attribute combination to operate on.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Boolean
- Whether to include the
tagsAttribute
value. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Hostname String - Specifies the hostname to match on as a Perl-compatible regular expression.
- replace
All Boolean - Replaces all matches when enabled, otherwise replaces only the first match.
- replacement
Hostname String - Specifies the replacement hostname for the tag to use.
- scope String
- Specifies the part of HTML content the
tagsAttribute
refers to. - String
- Specifies the tag or tag/attribute combination to operate on.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllHttpInCacheHierarchy
- Enabled bool
- Enables all HTTP requests for parent servers in the cache hierarchy.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables all HTTP requests for parent servers in the cache hierarchy.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables all HTTP requests for parent servers in the cache hierarchy.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables all HTTP requests for parent servers in the cache hierarchy.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables all HTTP requests for parent servers in the cache hierarchy.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables all HTTP requests for parent servers in the cache hierarchy.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowCloudletsOrigins
- Enabled bool
- Allows you to assign custom origin definitions referenced in sub-rules by
cloudletsOrigin
labels. If disabled, all sub-rules are ignored. - Honor
Base boolDirectory - 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.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Purge
Origin stringQuery Parameter - 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
Content Control Utility API
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Allows you to assign custom origin definitions referenced in sub-rules by
cloudletsOrigin
labels. If disabled, all sub-rules are ignored. - Honor
Base boolDirectory - 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.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Purge
Origin stringQuery Parameter - 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
Content Control Utility API
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows you to assign custom origin definitions referenced in sub-rules by
cloudletsOrigin
labels. If disabled, all sub-rules are ignored. - honor
Base BooleanDirectory - 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.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- purge
Origin StringQuery Parameter - 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
Content Control Utility API
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Allows you to assign custom origin definitions referenced in sub-rules by
cloudletsOrigin
labels. If disabled, all sub-rules are ignored. - honor
Base booleanDirectory - 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.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- purge
Origin stringQuery Parameter - 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
Content Control Utility API
. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Allows you to assign custom origin definitions referenced in sub-rules by
cloudletsOrigin
labels. If disabled, all sub-rules are ignored. - honor_
base_ booldirectory - 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.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- purge_
origin_ strquery_ parameter - 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
Content Control Utility API
. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows you to assign custom origin definitions referenced in sub-rules by
cloudletsOrigin
labels. If disabled, all sub-rules are ignored. - honor
Base BooleanDirectory - 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.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- purge
Origin StringQuery Parameter - 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
Content Control Utility API
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowDelete
- Allow
Body bool - Allows data in the body of the DELETE request.
- Enabled bool
- Allows DELETE requests. Content does
not
cache. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Allow
Body bool - Allows data in the body of the DELETE request.
- Enabled bool
- Allows DELETE requests. Content does
not
cache. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Body Boolean - Allows data in the body of the DELETE request.
- enabled Boolean
- Allows DELETE requests. Content does
not
cache. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Body boolean - Allows data in the body of the DELETE request.
- enabled boolean
- Allows DELETE requests. Content does
not
cache. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow_
body bool - Allows data in the body of the DELETE request.
- enabled bool
- Allows DELETE requests. Content does
not
cache. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Body Boolean - Allows data in the body of the DELETE request.
- enabled Boolean
- Allows DELETE requests. Content does
not
cache. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsCacheKeySharing
- Enabled bool
- Enables HTTPS cache key sharing.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables HTTPS cache key sharing.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables HTTPS cache key sharing.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables HTTPS cache key sharing.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables HTTPS cache key sharing.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables HTTPS cache key sharing.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowHttpsDowngrade
- Enabled bool
- Downgrades to HTTP protocol for the origin server.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Downgrades to HTTP protocol for the origin server.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Downgrades to HTTP protocol for the origin server.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Downgrades to HTTP protocol for the origin server.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Downgrades to HTTP protocol for the origin server.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Downgrades to HTTP protocol for the origin server.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowOptions
- Enabled bool
- Set this to
true
to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this tofalse
to deny OPTIONS requests and respond with a 501 error. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Set this to
true
to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this tofalse
to deny OPTIONS requests and respond with a 501 error. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Set this to
true
to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this tofalse
to deny OPTIONS requests and respond with a 501 error. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Set this to
true
to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this tofalse
to deny OPTIONS requests and respond with a 501 error. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Set this to
true
to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this tofalse
to deny OPTIONS requests and respond with a 501 error. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Set this to
true
to reflect the default policy where edge servers allow the OPTIONS method, without caching the response. Set this tofalse
to deny OPTIONS requests and respond with a 501 error. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowPatch
- Enabled bool
- Allows PATCH requests. Content does
not
cache. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Allows PATCH requests. Content does
not
cache. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows PATCH requests. Content does
not
cache. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Allows PATCH requests. Content does
not
cache. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Allows PATCH requests. Content does
not
cache. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows PATCH requests. Content does
not
cache. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowPost
- Allow
Without boolContent Length - By default, POST requests also require a
Content-Length
header, or they result in a 411 error. With this option enabled with no specifiedContent-Length
, the edge server relies on aTransfer-Encoding
header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a0
value to the forward request. - Enabled bool
- Allows POST requests.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Allow
Without boolContent Length - By default, POST requests also require a
Content-Length
header, or they result in a 411 error. With this option enabled with no specifiedContent-Length
, the edge server relies on aTransfer-Encoding
header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a0
value to the forward request. - Enabled bool
- Allows POST requests.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Without BooleanContent Length - By default, POST requests also require a
Content-Length
header, or they result in a 411 error. With this option enabled with no specifiedContent-Length
, the edge server relies on aTransfer-Encoding
header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a0
value to the forward request. - enabled Boolean
- Allows POST requests.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Without booleanContent Length - By default, POST requests also require a
Content-Length
header, or they result in a 411 error. With this option enabled with no specifiedContent-Length
, the edge server relies on aTransfer-Encoding
header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a0
value to the forward request. - enabled boolean
- Allows POST requests.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow_
without_ boolcontent_ length - By default, POST requests also require a
Content-Length
header, or they result in a 411 error. With this option enabled with no specifiedContent-Length
, the edge server relies on aTransfer-Encoding
header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a0
value to the forward request. - enabled bool
- Allows POST requests.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Without BooleanContent Length - By default, POST requests also require a
Content-Length
header, or they result in a 411 error. With this option enabled with no specifiedContent-Length
, the edge server relies on aTransfer-Encoding
header to chunk the data. If neither header is present, it assumes the request has no body, and it adds a header with a0
value to the forward request. - enabled Boolean
- Allows POST requests.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowPut
- Enabled bool
- Allows PUT requests. Content does
not
cache. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Allows PUT requests. Content does
not
cache. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows PUT requests. Content does
not
cache. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Allows PUT requests. Content does
not
cache. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Allows PUT requests. Content does
not
cache. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows PUT requests. Content does
not
cache. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAllowTransferEncoding
- Enabled bool
- Allows Chunked Transfer Encoding requests.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Allows Chunked Transfer Encoding requests.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows Chunked Transfer Encoding requests.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Allows Chunked Transfer Encoding requests.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Allows Chunked Transfer Encoding requests.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows Chunked Transfer Encoding requests.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAltSvcHeader
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Max
Age int - Specifies the
max-age
value in seconds for theAlt-Svc
header. The defaultmax-age
for anAlt-Svc
header is 93600 seconds (26 hours). - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Max
Age int - Specifies the
max-age
value in seconds for theAlt-Svc
header. The defaultmax-age
for anAlt-Svc
header is 93600 seconds (26 hours). - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- max
Age Integer - Specifies the
max-age
value in seconds for theAlt-Svc
header. The defaultmax-age
for anAlt-Svc
header is 93600 seconds (26 hours). - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- max
Age number - Specifies the
max-age
value in seconds for theAlt-Svc
header. The defaultmax-age
for anAlt-Svc
header is 93600 seconds (26 hours). - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- max_
age int - Specifies the
max-age
value in seconds for theAlt-Svc
header. The defaultmax-age
for anAlt-Svc
header is 93600 seconds (26 hours). - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- max
Age Number - Specifies the
max-age
value in seconds for theAlt-Svc
header. The defaultmax-age
for anAlt-Svc
header is 93600 seconds (26 hours). - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritization
- Alternate
Response intCache Ttl - Specifies the alternate response's time to live in the cache,
5
minutes by default. - Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Activates the API Prioritization feature.
- Label string
- A label to distinguish this API Prioritization policy from any others in the same property.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Net
Storage GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Net Storage - Specify the NetStorage domain that contains the alternate response.
- Net
Storage stringPath - Specify the full NetStorage path for the alternate response, including trailing file name.
- Template
Uuid string - This option is for internal usage only.
- Throttled
Cp GetCode Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Throttled
Status intCode - Specifies the HTTP response code for requests that receive the alternate response.
- Use
Throttled boolCp Code - Specifies whether to apply an alternative CP code for requests served the alternate response.
- Use
Throttled boolStatus Code - Allows you to assign a specific HTTP response code to a throttled request.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Alternate
Response intCache Ttl - Specifies the alternate response's time to live in the cache,
5
minutes by default. - Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Activates the API Prioritization feature.
- Label string
- A label to distinguish this API Prioritization policy from any others in the same property.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Net
Storage GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Net Storage - Specify the NetStorage domain that contains the alternate response.
- Net
Storage stringPath - Specify the full NetStorage path for the alternate response, including trailing file name.
- Template
Uuid string - This option is for internal usage only.
- Throttled
Cp GetCode Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Throttled
Status intCode - Specifies the HTTP response code for requests that receive the alternate response.
- Use
Throttled boolCp Code - Specifies whether to apply an alternative CP code for requests served the alternate response.
- Use
Throttled boolStatus Code - Allows you to assign a specific HTTP response code to a throttled request.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- alternate
Response IntegerCache Ttl - Specifies the alternate response's time to live in the cache,
5
minutes by default. - cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Cloudlet Policy - Identifies the Cloudlet policy.
- enabled Boolean
- Activates the API Prioritization feature.
- label String
- A label to distinguish this API Prioritization policy from any others in the same property.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- net
Storage GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Net Storage - Specify the NetStorage domain that contains the alternate response.
- net
Storage StringPath - Specify the full NetStorage path for the alternate response, including trailing file name.
- template
Uuid String - This option is for internal usage only.
- throttled
Cp GetCode Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - throttled
Status IntegerCode - Specifies the HTTP response code for requests that receive the alternate response.
- use
Throttled BooleanCp Code - Specifies whether to apply an alternative CP code for requests served the alternate response.
- use
Throttled BooleanStatus Code - Allows you to assign a specific HTTP response code to a throttled request.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- alternate
Response numberCache Ttl - Specifies the alternate response's time to live in the cache,
5
minutes by default. - cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Cloudlet Policy - Identifies the Cloudlet policy.
- enabled boolean
- Activates the API Prioritization feature.
- label string
- A label to distinguish this API Prioritization policy from any others in the same property.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- net
Storage GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Net Storage - Specify the NetStorage domain that contains the alternate response.
- net
Storage stringPath - Specify the full NetStorage path for the alternate response, including trailing file name.
- template
Uuid string - This option is for internal usage only.
- throttled
Cp GetCode Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - throttled
Status numberCode - Specifies the HTTP response code for requests that receive the alternate response.
- use
Throttled booleanCp Code - Specifies whether to apply an alternative CP code for requests served the alternate response.
- use
Throttled booleanStatus Code - Allows you to assign a specific HTTP response code to a throttled request.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- alternate_
response_ intcache_ ttl - Specifies the alternate response's time to live in the cache,
5
minutes by default. - cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Cloudlet Policy - Identifies the Cloudlet policy.
- enabled bool
- Activates the API Prioritization feature.
- label str
- A label to distinguish this API Prioritization policy from any others in the same property.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- net_
storage GetProperty Rules Builder Rules V20230105Behavior Api Prioritization Net Storage - Specify the NetStorage domain that contains the alternate response.
- net_
storage_ strpath - Specify the full NetStorage path for the alternate response, including trailing file name.
- template_
uuid str - This option is for internal usage only.
- throttled_
cp_ Getcode Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - throttled_
status_ intcode - Specifies the HTTP response code for requests that receive the alternate response.
- use_
throttled_ boolcp_ code - Specifies whether to apply an alternative CP code for requests served the alternate response.
- use_
throttled_ boolstatus_ code - Allows you to assign a specific HTTP response code to a throttled request.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- alternate
Response NumberCache Ttl - Specifies the alternate response's time to live in the cache,
5
minutes by default. - cloudlet
Policy Property Map - Identifies the Cloudlet policy.
- enabled Boolean
- Activates the API Prioritization feature.
- label String
- A label to distinguish this API Prioritization policy from any others in the same property.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- net
Storage Property Map - Specify the NetStorage domain that contains the alternate response.
- net
Storage StringPath - Specify the full NetStorage path for the alternate response, including trailing file name.
- template
Uuid String - This option is for internal usage only.
- throttled
Cp Property MapCode - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - throttled
Status NumberCode - Specifies the HTTP response code for requests that receive the alternate response.
- use
Throttled BooleanCp Code - Specifies whether to apply an alternative CP code for requests served the alternate response.
- use
Throttled BooleanStatus Code - Allows you to assign a specific HTTP response code to a throttled request.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationCloudletPolicy
GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationNetStorage
- Cp
Code int - Download
Domain stringName - G2o
Token string
- Cp
Code int - Download
Domain stringName - G2o
Token string
- cp
Code Integer - download
Domain StringName - g2o
Token String
- cp
Code number - download
Domain stringName - g2o
Token string
- cp_
code int - download_
domain_ strname - g2o_
token str
- cp
Code Number - download
Domain StringName - g2o
Token String
GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCode
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Api Prioritization Throttled Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorApiPrioritizationThrottledCpCodeCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancer
- All
Down GetNet Storage Property Rules Builder Rules V20230105Behavior Application Load Balancer All Down Net Storage - Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
- All
Down stringNet Storage File - Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
- All
Down stringStatus Code - Specifies the HTTP response code when all load-balancing origins are unavailable.
- All
Down stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Allow
Cache boolPrefresh - Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
- Cached
Content stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Application Load Balancer Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Activates the Application Load Balancer Cloudlet.
- Failover
Attempts intThreshold - Sets the number of failed requests that would trigger the failover process.
- Failover
Mode string - Determines what to do if an origin fails.
- Failover
Origin List<GetMaps Property Rules Builder Rules V20230105Behavior Application Load Balancer Failover Origin Map> - Specifies a fixed set of failover mapping rules.
- Failover
Status List<string>Codes - 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.
- Failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Label string
- A label to distinguish this Application Load Balancer policy from any others within the same property.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- Specifies the name for your session cookie.
- bool
- Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
- bool
- 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. - string
- Specifies the domain to track the stickiness cookie.
- string
- Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
- bool
- Ensures the cookie is transmitted only over HTTP.
- string
- Determines how a cookie persistently associates the client with a load-balanced origin.
- Stickiness
Duration string - Sets how long it is before the cookie expires.
- Stickiness
Expiration stringDate - Specifies when the cookie expires.
- Stickiness
Refresh bool - 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. - Stickiness
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- All
Down GetNet Storage Property Rules Builder Rules V20230105Behavior Application Load Balancer All Down Net Storage - Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
- All
Down stringNet Storage File - Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
- All
Down stringStatus Code - Specifies the HTTP response code when all load-balancing origins are unavailable.
- All
Down stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Allow
Cache boolPrefresh - Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
- Cached
Content stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Application Load Balancer Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Activates the Application Load Balancer Cloudlet.
- Failover
Attempts intThreshold - Sets the number of failed requests that would trigger the failover process.
- Failover
Mode string - Determines what to do if an origin fails.
- Failover
Origin []GetMaps Property Rules Builder Rules V20230105Behavior Application Load Balancer Failover Origin Map - Specifies a fixed set of failover mapping rules.
- Failover
Status []stringCodes - 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.
- Failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Label string
- A label to distinguish this Application Load Balancer policy from any others within the same property.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- Specifies the name for your session cookie.
- bool
- Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
- bool
- 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. - string
- Specifies the domain to track the stickiness cookie.
- string
- Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
- bool
- Ensures the cookie is transmitted only over HTTP.
- string
- Determines how a cookie persistently associates the client with a load-balanced origin.
- Stickiness
Duration string - Sets how long it is before the cookie expires.
- Stickiness
Expiration stringDate - Specifies when the cookie expires.
- Stickiness
Refresh bool - 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. - Stickiness
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- all
Down GetNet Storage Property Rules Builder Rules V20230105Behavior Application Load Balancer All Down Net Storage - Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
- all
Down StringNet Storage File - Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
- all
Down StringStatus Code - Specifies the HTTP response code when all load-balancing origins are unavailable.
- all
Down StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- allow
Cache BooleanPrefresh - Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
- cached
Content StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Application Load Balancer Cloudlet Policy - Identifies the Cloudlet policy.
- enabled Boolean
- Activates the Application Load Balancer Cloudlet.
- failover
Attempts IntegerThreshold - Sets the number of failed requests that would trigger the failover process.
- failover
Mode String - Determines what to do if an origin fails.
- failover
Origin List<GetMaps Property Rules Builder Rules V20230105Behavior Application Load Balancer Failover Origin Map> - Specifies a fixed set of failover mapping rules.
- failover
Status List<String>Codes - 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.
- failover
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- label String
- A label to distinguish this Application Load Balancer policy from any others within the same property.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- String
- Specifies the name for your session cookie.
- Boolean
- Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
- 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. - String
- Specifies the domain to track the stickiness cookie.
- String
- Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
- Boolean
- Ensures the cookie is transmitted only over HTTP.
- String
- Determines how a cookie persistently associates the client with a load-balanced origin.
- stickiness
Duration String - Sets how long it is before the cookie expires.
- stickiness
Expiration StringDate - Specifies when the cookie expires.
- stickiness
Refresh Boolean - 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. - stickiness
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- all
Down GetNet Storage Property Rules Builder Rules V20230105Behavior Application Load Balancer All Down Net Storage - Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
- all
Down stringNet Storage File - Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
- all
Down stringStatus Code - Specifies the HTTP response code when all load-balancing origins are unavailable.
- all
Down stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- allow
Cache booleanPrefresh - Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
- cached
Content stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Application Load Balancer Cloudlet Policy - Identifies the Cloudlet policy.
- enabled boolean
- Activates the Application Load Balancer Cloudlet.
- failover
Attempts numberThreshold - Sets the number of failed requests that would trigger the failover process.
- failover
Mode string - Determines what to do if an origin fails.
- failover
Origin GetMaps Property Rules Builder Rules V20230105Behavior Application Load Balancer Failover Origin Map[] - Specifies a fixed set of failover mapping rules.
- failover
Status string[]Codes - 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.
- failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- label string
- A label to distinguish this Application Load Balancer policy from any others within the same property.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- Specifies the name for your session cookie.
- boolean
- Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
- 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. - string
- Specifies the domain to track the stickiness cookie.
- string
- Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
- boolean
- Ensures the cookie is transmitted only over HTTP.
- string
- Determines how a cookie persistently associates the client with a load-balanced origin.
- stickiness
Duration string - Sets how long it is before the cookie expires.
- stickiness
Expiration stringDate - Specifies when the cookie expires.
- stickiness
Refresh boolean - 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. - stickiness
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- all_
down_ Getnet_ storage Property Rules Builder Rules V20230105Behavior Application Load Balancer All Down Net Storage - Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
- all_
down_ strnet_ storage_ file - Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
- all_
down_ strstatus_ code - Specifies the HTTP response code when all load-balancing origins are unavailable.
- all_
down_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- allow_
cache_ boolprefresh - Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
- cached_
content_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior Application Load Balancer Cloudlet Policy - Identifies the Cloudlet policy.
- enabled bool
- Activates the Application Load Balancer Cloudlet.
- failover_
attempts_ intthreshold - Sets the number of failed requests that would trigger the failover process.
- failover_
mode str - Determines what to do if an origin fails.
- failover_
origin_ Sequence[Getmaps Property Rules Builder Rules V20230105Behavior Application Load Balancer Failover Origin Map] - Specifies a fixed set of failover mapping rules.
- failover_
status_ Sequence[str]codes - 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.
- failover_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- label str
- A label to distinguish this Application Load Balancer policy from any others within the same property.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- str
- Specifies the name for your session cookie.
- bool
- Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
- bool
- 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. - str
- Specifies the domain to track the stickiness cookie.
- str
- Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
- bool
- Ensures the cookie is transmitted only over HTTP.
- str
- Determines how a cookie persistently associates the client with a load-balanced origin.
- stickiness_
duration str - Sets how long it is before the cookie expires.
- stickiness_
expiration_ strdate - Specifies when the cookie expires.
- stickiness_
refresh bool - 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. - stickiness_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- all
Down Property MapNet Storage - Specifies a NetStorage account for a static maintenance page as a fallback when no origins are available.
- all
Down StringNet Storage File - Specifies the fallback maintenance page's filename, expressed as a full path from the root of the NetStorage server.
- all
Down StringStatus Code - Specifies the HTTP response code when all load-balancing origins are unavailable.
- all
Down StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- allow
Cache BooleanPrefresh - Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.
- cached
Content StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cloudlet
Policy Property Map - Identifies the Cloudlet policy.
- enabled Boolean
- Activates the Application Load Balancer Cloudlet.
- failover
Attempts NumberThreshold - Sets the number of failed requests that would trigger the failover process.
- failover
Mode String - Determines what to do if an origin fails.
- failover
Origin List<Property Map>Maps - Specifies a fixed set of failover mapping rules.
- failover
Status List<String>Codes - 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.
- failover
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- label String
- A label to distinguish this Application Load Balancer policy from any others within the same property.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- String
- Specifies the name for your session cookie.
- Boolean
- Specifies whether to use a cookie domain with the stickiness cookie, to tell the browser to which domain to send the cookie.
- 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. - String
- Specifies the domain to track the stickiness cookie.
- String
- Specifies the stickiness cookie's salt value. Use this option to share the cookie across many properties.
- Boolean
- Ensures the cookie is transmitted only over HTTP.
- String
- Determines how a cookie persistently associates the client with a load-balanced origin.
- stickiness
Duration String - Sets how long it is before the cookie expires.
- stickiness
Expiration StringDate - Specifies when the cookie expires.
- stickiness
Refresh Boolean - 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. - stickiness
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerAllDownNetStorage
- Cp
Code int - Download
Domain stringName - G2o
Token string
- Cp
Code int - Download
Domain stringName - G2o
Token string
- cp
Code Integer - download
Domain StringName - g2o
Token String
- cp
Code number - download
Domain stringName - g2o
Token string
- cp_
code int - download_
domain_ strname - g2o_
token str
- cp
Code Number - download
Domain StringName - g2o
Token String
GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerCloudletPolicy
GetPropertyRulesBuilderRulesV20230105BehaviorApplicationLoadBalancerFailoverOriginMap
- From
Origin stringId - Specifies the origin whose failure triggers the mapping rule.
- To
Origin List<string>Ids - Requests stuck to the
fromOriginId
origin retry for each alternate origintoOriginIds
, until one succeeds.
- From
Origin stringId - Specifies the origin whose failure triggers the mapping rule.
- To
Origin []stringIds - Requests stuck to the
fromOriginId
origin retry for each alternate origintoOriginIds
, until one succeeds.
- from
Origin StringId - Specifies the origin whose failure triggers the mapping rule.
- to
Origin List<String>Ids - Requests stuck to the
fromOriginId
origin retry for each alternate origintoOriginIds
, until one succeeds.
- from
Origin stringId - Specifies the origin whose failure triggers the mapping rule.
- to
Origin string[]Ids - Requests stuck to the
fromOriginId
origin retry for each alternate origintoOriginIds
, until one succeeds.
- from_
origin_ strid - Specifies the origin whose failure triggers the mapping rule.
- to_
origin_ Sequence[str]ids - Requests stuck to the
fromOriginId
origin retry for each alternate origintoOriginIds
, until one succeeds.
- from
Origin StringId - Specifies the origin whose failure triggers the mapping rule.
- to
Origin List<String>Ids - Requests stuck to the
fromOriginId
origin retry for each alternate origintoOriginIds
, until one succeeds.
GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentation
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation Cloudlet Policy - Identifies the Cloudlet policy.
- int
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - Enabled bool
- Enables the Audience Segmentation cloudlet feature.
- bool
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - 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.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- bool
- 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. - string
- Specifies the domain to track the population cookie.
- bool
- When enabled, includes in the session cookie the name of the rule in which this behavior appears.
- string
- Specifies the cookie's salt value. Use this option to share the cookie across many properties.
- string
- Specifies when the segmentation cookie expires.
- Population
Duration string - Specifies the lifetime of the segmentation cookie.
- Population
Refresh bool - If disabled, sets the expiration time only if the cookie is not yet present in the request.
- Population
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- string
- This cookie name specifies the name of the segmentation rule.
- Segment
Tracking stringCustom Header - This custom HTTP header specifies the name of the segmentation rule.
- Segment
Tracking stringMethod - Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
- Segment
Tracking stringQuery Param - This query parameter specifies the name of the segmentation rule.
- Segment
Tracking stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- bool
- Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation Cloudlet Policy - Identifies the Cloudlet policy.
- int
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - Enabled bool
- Enables the Audience Segmentation cloudlet feature.
- bool
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - 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.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- bool
- 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. - string
- Specifies the domain to track the population cookie.
- bool
- When enabled, includes in the session cookie the name of the rule in which this behavior appears.
- string
- Specifies the cookie's salt value. Use this option to share the cookie across many properties.
- string
- Specifies when the segmentation cookie expires.
- Population
Duration string - Specifies the lifetime of the segmentation cookie.
- Population
Refresh bool - If disabled, sets the expiration time only if the cookie is not yet present in the request.
- Population
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- string
- This cookie name specifies the name of the segmentation rule.
- Segment
Tracking stringCustom Header - This custom HTTP header specifies the name of the segmentation rule.
- Segment
Tracking stringMethod - Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
- Segment
Tracking stringQuery Param - This query parameter specifies the name of the segmentation rule.
- Segment
Tracking stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- bool
- Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation Cloudlet Policy - Identifies the Cloudlet policy.
- Integer
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - enabled Boolean
- Enables the Audience Segmentation cloudlet feature.
- Boolean
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - 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.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- 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. - String
- Specifies the domain to track the population cookie.
- Boolean
- When enabled, includes in the session cookie the name of the rule in which this behavior appears.
- String
- Specifies the cookie's salt value. Use this option to share the cookie across many properties.
- String
- Specifies when the segmentation cookie expires.
- population
Duration String - Specifies the lifetime of the segmentation cookie.
- population
Refresh Boolean - If disabled, sets the expiration time only if the cookie is not yet present in the request.
- population
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- String
- This cookie name specifies the name of the segmentation rule.
- segment
Tracking StringCustom Header - This custom HTTP header specifies the name of the segmentation rule.
- segment
Tracking StringMethod - Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
- segment
Tracking StringQuery Param - This query parameter specifies the name of the segmentation rule.
- segment
Tracking StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Boolean
- Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation Cloudlet Policy - Identifies the Cloudlet policy.
- number
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - enabled boolean
- Enables the Audience Segmentation cloudlet feature.
- boolean
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - 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.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- 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. - string
- Specifies the domain to track the population cookie.
- boolean
- When enabled, includes in the session cookie the name of the rule in which this behavior appears.
- string
- Specifies the cookie's salt value. Use this option to share the cookie across many properties.
- string
- Specifies when the segmentation cookie expires.
- population
Duration string - Specifies the lifetime of the segmentation cookie.
- population
Refresh boolean - If disabled, sets the expiration time only if the cookie is not yet present in the request.
- population
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- string
- This cookie name specifies the name of the segmentation rule.
- segment
Tracking stringCustom Header - This custom HTTP header specifies the name of the segmentation rule.
- segment
Tracking stringMethod - Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
- segment
Tracking stringQuery Param - This query parameter specifies the name of the segmentation rule.
- segment
Tracking stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- boolean
- Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior Audience Segmentation Cloudlet Policy - Identifies the Cloudlet policy.
- int
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - enabled bool
- Enables the Audience Segmentation cloudlet feature.
- bool
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - label str
- Specifies a suffix to append to the cookie name. This helps distinguish this audience segmentation policy from any others within the same property.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- bool
- 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. - str
- Specifies the domain to track the population cookie.
- bool
- When enabled, includes in the session cookie the name of the rule in which this behavior appears.
- str
- Specifies the cookie's salt value. Use this option to share the cookie across many properties.
- str
- Specifies when the segmentation cookie expires.
- population_
duration str - Specifies the lifetime of the segmentation cookie.
- population_
refresh bool - If disabled, sets the expiration time only if the cookie is not yet present in the request.
- population_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- str
- This cookie name specifies the name of the segmentation rule.
- segment_
tracking_ strcustom_ header - This custom HTTP header specifies the name of the segmentation rule.
- segment_
tracking_ strmethod - Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
- segment_
tracking_ strquery_ param - This query parameter specifies the name of the segmentation rule.
- segment_
tracking_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- bool
- Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy Property Map - Identifies the Cloudlet policy.
- Number
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - enabled Boolean
- Enables the Audience Segmentation cloudlet feature.
- Boolean
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - 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.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- 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. - String
- Specifies the domain to track the population cookie.
- Boolean
- When enabled, includes in the session cookie the name of the rule in which this behavior appears.
- String
- Specifies the cookie's salt value. Use this option to share the cookie across many properties.
- String
- Specifies when the segmentation cookie expires.
- population
Duration String - Specifies the lifetime of the segmentation cookie.
- population
Refresh Boolean - If disabled, sets the expiration time only if the cookie is not yet present in the request.
- population
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- String
- This cookie name specifies the name of the segmentation rule.
- segment
Tracking StringCustom Header - This custom HTTP header specifies the name of the segmentation rule.
- segment
Tracking StringMethod - Specifies the method to pass segment information to the origin. The Cloudlet passes the rule applied to a given request location.
- segment
Tracking StringQuery Param - This query parameter specifies the name of the segmentation rule.
- segment
Tracking StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Boolean
- Whether to specify a cookie domain with the population cookie. It tells the browser to which domain to send the cookie.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorAudienceSegmentationCloudletPolicy
GetPropertyRulesBuilderRulesV20230105BehaviorAutoDomainValidation
- Autodv string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Autodv string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- autodv String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- autodv string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- autodv str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- autodv String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorBaseDirectory
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Value string
- Specifies the base path of content on your origin server. The value needs to begin and end with a slash (
/
) character, for example/parent/child/
.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Value string
- Specifies the base path of content on your origin server. The value needs to begin and end with a slash (
/
) character, for example/parent/child/
.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value String
- Specifies the base path of content on your origin server. The value needs to begin and end with a slash (
/
) character, for example/parent/child/
.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value string
- Specifies the base path of content on your origin server. The value needs to begin and end with a slash (
/
) character, for example/parent/child/
.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value str
- Specifies the base path of content on your origin server. The value needs to begin and end with a slash (
/
) character, for example/parent/child/
.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value String
- Specifies the base path of content on your origin server. The value needs to begin and end with a slash (
/
) character, for example/parent/child/
.
GetPropertyRulesBuilderRulesV20230105BehaviorBossBeaconing
- Conditional
Error stringPattern - A space-separated set of error patterns that trigger beacons to conditional feeds. Each pattern can include wildcards, where
?
matches a single character and*
matches zero or more characters. For example,*CONNECT* *DENIED*
matches two different words as substrings. - Conditional
Http List<string>Statuses - Specifies the set of response status codes or ranges that trigger the beacon.
- Conditional
Sampling stringFrequency - Specifies a conditional sampling frequency or disables 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.
- Enabled bool
- Enable diagnostic data beacons.
- Forward
Type string - Specify when to trigger a beacon.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Request
Type string - Specify when to trigger a beacon.
- Sampling
Frequency string - Specifies a sampling frequency or disables beacons.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Conditional
Error stringPattern - A space-separated set of error patterns that trigger beacons to conditional feeds. Each pattern can include wildcards, where
?
matches a single character and*
matches zero or more characters. For example,*CONNECT* *DENIED*
matches two different words as substrings. - Conditional
Http []stringStatuses - Specifies the set of response status codes or ranges that trigger the beacon.
- Conditional
Sampling stringFrequency - Specifies a conditional sampling frequency or disables 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.
- Enabled bool
- Enable diagnostic data beacons.
- Forward
Type string - Specify when to trigger a beacon.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Request
Type string - Specify when to trigger a beacon.
- Sampling
Frequency string - Specifies a sampling frequency or disables beacons.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- conditional
Error StringPattern - A space-separated set of error patterns that trigger beacons to conditional feeds. Each pattern can include wildcards, where
?
matches a single character and*
matches zero or more characters. For example,*CONNECT* *DENIED*
matches two different words as substrings. - conditional
Http List<String>Statuses - Specifies the set of response status codes or ranges that trigger the beacon.
- conditional
Sampling StringFrequency - Specifies a conditional sampling frequency or disables 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.
- enabled Boolean
- Enable diagnostic data beacons.
- forward
Type String - Specify when to trigger a beacon.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- request
Type String - Specify when to trigger a beacon.
- sampling
Frequency String - Specifies a sampling frequency or disables beacons.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- conditional
Error stringPattern - A space-separated set of error patterns that trigger beacons to conditional feeds. Each pattern can include wildcards, where
?
matches a single character and*
matches zero or more characters. For example,*CONNECT* *DENIED*
matches two different words as substrings. - conditional
Http string[]Statuses - Specifies the set of response status codes or ranges that trigger the beacon.
- conditional
Sampling stringFrequency - Specifies a conditional sampling frequency or disables 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.
- enabled boolean
- Enable diagnostic data beacons.
- forward
Type string - Specify when to trigger a beacon.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- request
Type string - Specify when to trigger a beacon.
- sampling
Frequency string - Specifies a sampling frequency or disables beacons.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- conditional_
error_ strpattern - A space-separated set of error patterns that trigger beacons to conditional feeds. Each pattern can include wildcards, where
?
matches a single character and*
matches zero or more characters. For example,*CONNECT* *DENIED*
matches two different words as substrings. - conditional_
http_ Sequence[str]statuses - Specifies the set of response status codes or ranges that trigger the beacon.
- conditional_
sampling_ strfrequency - Specifies a conditional sampling frequency or disables beacons.
- cpcodes str
- The space-separated list of CP codes that trigger the beacons. You need to specify the same set of CP codes within BOSS.
- enabled bool
- Enable diagnostic data beacons.
- forward_
type str - Specify when to trigger a beacon.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- request_
type str - Specify when to trigger a beacon.
- sampling_
frequency str - Specifies a sampling frequency or disables beacons.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- conditional
Error StringPattern - A space-separated set of error patterns that trigger beacons to conditional feeds. Each pattern can include wildcards, where
?
matches a single character and*
matches zero or more characters. For example,*CONNECT* *DENIED*
matches two different words as substrings. - conditional
Http List<String>Statuses - Specifies the set of response status codes or ranges that trigger the beacon.
- conditional
Sampling StringFrequency - Specifies a conditional sampling frequency or disables 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.
- enabled Boolean
- Enable diagnostic data beacons.
- forward
Type String - Specify when to trigger a beacon.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- request
Type String - Specify when to trigger a beacon.
- sampling
Frequency String - Specifies a sampling frequency or disables beacons.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorBreadcrumbs
- Enabled bool
- Enables the Breadcrumbs feature.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Logging
Enabled bool - Whether to collect all Breadcrumbs data in logs, including the response headers sent a requesting client. This can also be helpful if you're using
DataStream 2
to retrieve log data. This way, all Breadcrumbs data is carried in the logs it uses. - Opt
Mode bool - Specifies whether to include Breadcrumbs data in the response header. To bypass the current
optMode
, append the oppositeak-bc
query string to each request from your player. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the Breadcrumbs feature.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Logging
Enabled bool - Whether to collect all Breadcrumbs data in logs, including the response headers sent a requesting client. This can also be helpful if you're using
DataStream 2
to retrieve log data. This way, all Breadcrumbs data is carried in the logs it uses. - Opt
Mode bool - Specifies whether to include Breadcrumbs data in the response header. To bypass the current
optMode
, append the oppositeak-bc
query string to each request from your player. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Breadcrumbs feature.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- logging
Enabled Boolean - Whether to collect all Breadcrumbs data in logs, including the response headers sent a requesting client. This can also be helpful if you're using
DataStream 2
to retrieve log data. This way, all Breadcrumbs data is carried in the logs it uses. - opt
Mode Boolean - Specifies whether to include Breadcrumbs data in the response header. To bypass the current
optMode
, append the oppositeak-bc
query string to each request from your player. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the Breadcrumbs feature.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- logging
Enabled boolean - Whether to collect all Breadcrumbs data in logs, including the response headers sent a requesting client. This can also be helpful if you're using
DataStream 2
to retrieve log data. This way, all Breadcrumbs data is carried in the logs it uses. - opt
Mode boolean - Specifies whether to include Breadcrumbs data in the response header. To bypass the current
optMode
, append the oppositeak-bc
query string to each request from your player. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the Breadcrumbs feature.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- logging_
enabled bool - Whether to collect all Breadcrumbs data in logs, including the response headers sent a requesting client. This can also be helpful if you're using
DataStream 2
to retrieve log data. This way, all Breadcrumbs data is carried in the logs it uses. - opt_
mode bool - Specifies whether to include Breadcrumbs data in the response header. To bypass the current
optMode
, append the oppositeak-bc
query string to each request from your player. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Breadcrumbs feature.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- logging
Enabled Boolean - Whether to collect all Breadcrumbs data in logs, including the response headers sent a requesting client. This can also be helpful if you're using
DataStream 2
to retrieve log data. This way, all Breadcrumbs data is carried in the logs it uses. - opt
Mode Boolean - Specifies whether to include Breadcrumbs data in the response header. To bypass the current
optMode
, append the oppositeak-bc
query string to each request from your player. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorBreakConnection
- Enabled bool
- Enables the break connection behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the break connection behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the break connection behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the break connection behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the break connection behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the break connection behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorBrotli
- Enabled bool
- Fetches Brotli-compressed assets from your origin and caches them on edge servers.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Fetches Brotli-compressed assets from your origin and caches them on edge servers.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Fetches Brotli-compressed assets from your origin and caches them on edge servers.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Fetches Brotli-compressed assets from your origin and caches them on edge servers.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Fetches Brotli-compressed assets from your origin and caches them on edge servers.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Fetches Brotli-compressed assets from your origin and caches them on edge servers.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCacheError
- Enabled bool
- Activates the error-caching behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Preserve
Stale bool - When enabled, the edge server preserves stale cached objects when the origin returns
500
,502
,503
, and504
error codes. This avoids re-fetching and re-caching content after transient errors. - Template
Uuid string - This option is for internal usage only.
- Ttl string
- Overrides the default caching duration of
10s
. Note that if set to0
, it is equivalent tono-cache
, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of500
. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Activates the error-caching behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Preserve
Stale bool - When enabled, the edge server preserves stale cached objects when the origin returns
500
,502
,503
, and504
error codes. This avoids re-fetching and re-caching content after transient errors. - Template
Uuid string - This option is for internal usage only.
- Ttl string
- Overrides the default caching duration of
10s
. Note that if set to0
, it is equivalent tono-cache
, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of500
. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Activates the error-caching behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- preserve
Stale Boolean - When enabled, the edge server preserves stale cached objects when the origin returns
500
,502
,503
, and504
error codes. This avoids re-fetching and re-caching content after transient errors. - template
Uuid String - This option is for internal usage only.
- ttl String
- Overrides the default caching duration of
10s
. Note that if set to0
, it is equivalent tono-cache
, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of500
. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Activates the error-caching behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- preserve
Stale boolean - When enabled, the edge server preserves stale cached objects when the origin returns
500
,502
,503
, and504
error codes. This avoids re-fetching and re-caching content after transient errors. - template
Uuid string - This option is for internal usage only.
- ttl string
- Overrides the default caching duration of
10s
. Note that if set to0
, it is equivalent tono-cache
, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of500
. - uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Activates the error-caching behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- preserve_
stale bool - When enabled, the edge server preserves stale cached objects when the origin returns
500
,502
,503
, and504
error codes. This avoids re-fetching and re-caching content after transient errors. - template_
uuid str - This option is for internal usage only.
- ttl str
- Overrides the default caching duration of
10s
. Note that if set to0
, it is equivalent tono-cache
, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of500
. - uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Activates the error-caching behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- preserve
Stale Boolean - When enabled, the edge server preserves stale cached objects when the origin returns
500
,502
,503
, and504
error codes. This avoids re-fetching and re-caching content after transient errors. - template
Uuid String - This option is for internal usage only.
- ttl String
- Overrides the default caching duration of
10s
. Note that if set to0
, it is equivalent tono-cache
, which forces revalidation and may cause a traffic spike. This can be counterproductive when, for example, the origin is producing an error code of500
. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCacheId
- Elements List<string>
- Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
- Include
Value bool - Includes the value of the specified elements in the cache ID. Otherwise only their names are included.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Optional bool
- Requires the behavior's specified elements to be present for content to cache. When disabled, requests that lack the specified elements are still cached.
- Rule string
- Specifies how to modify the cache ID.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Variable
Name string - Specifies the name of the variable you want to include in the cache key.
- Elements []string
- Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
- Include
Value bool - Includes the value of the specified elements in the cache ID. Otherwise only their names are included.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Optional bool
- Requires the behavior's specified elements to be present for content to cache. When disabled, requests that lack the specified elements are still cached.
- Rule string
- Specifies how to modify the cache ID.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Variable
Name string - Specifies the name of the variable you want to include in the cache key.
- elements List<String>
- Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
- include
Value Boolean - Includes the value of the specified elements in the cache ID. Otherwise only their names are included.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- optional Boolean
- Requires the behavior's specified elements to be present for content to cache. When disabled, requests that lack the specified elements are still cached.
- rule String
- Specifies how to modify the cache ID.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- variable
Name String - Specifies the name of the variable you want to include in the cache key.
- elements string[]
- Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
- include
Value boolean - Includes the value of the specified elements in the cache ID. Otherwise only their names are included.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- optional boolean
- Requires the behavior's specified elements to be present for content to cache. When disabled, requests that lack the specified elements are still cached.
- rule string
- Specifies how to modify the cache ID.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- variable
Name string - Specifies the name of the variable you want to include in the cache key.
- elements Sequence[str]
- Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
- include_
value bool - Includes the value of the specified elements in the cache ID. Otherwise only their names are included.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- optional bool
- Requires the behavior's specified elements to be present for content to cache. When disabled, requests that lack the specified elements are still cached.
- rule str
- Specifies how to modify the cache ID.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- variable_
name str - Specifies the name of the variable you want to include in the cache key.
- elements List<String>
- Specifies the names of the query parameters, cookies, or headers to include or exclude from the cache ID.
- include
Value Boolean - Includes the value of the specified elements in the cache ID. Otherwise only their names are included.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- optional Boolean
- Requires the behavior's specified elements to be present for content to cache. When disabled, requests that lack the specified elements are still cached.
- rule String
- Specifies how to modify the cache ID.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- variable
Name String - Specifies the name of the variable you want to include in the cache key.
GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyIgnoreCase
- Enabled bool
- Ignores case when forming cache keys.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Ignores case when forming cache keys.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Ignores case when forming cache keys.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Ignores case when forming cache keys.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Ignores case when forming cache keys.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Ignores case when forming cache keys.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyQueryParams
- Behavior string
- Configures how sets of query string parameters translate to cache keys. Be careful not to ignore any parameters that result in substantially different content, as it is
not
reflected in the cached object. - Exact
Match bool - When enabled,
parameters
needs to match exactly. Keep disabled to match string prefixes. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Parameters List<string>
- 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.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Behavior string
- Configures how sets of query string parameters translate to cache keys. Be careful not to ignore any parameters that result in substantially different content, as it is
not
reflected in the cached object. - Exact
Match bool - When enabled,
parameters
needs to match exactly. Keep disabled to match string prefixes. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Parameters []string
- 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.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior String
- Configures how sets of query string parameters translate to cache keys. Be careful not to ignore any parameters that result in substantially different content, as it is
not
reflected in the cached object. - exact
Match Boolean - When enabled,
parameters
needs to match exactly. Keep disabled to match string prefixes. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- parameters List<String>
- 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.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior string
- Configures how sets of query string parameters translate to cache keys. Be careful not to ignore any parameters that result in substantially different content, as it is
not
reflected in the cached object. - exact
Match boolean - When enabled,
parameters
needs to match exactly. Keep disabled to match string prefixes. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- parameters string[]
- 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.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior str
- Configures how sets of query string parameters translate to cache keys. Be careful not to ignore any parameters that result in substantially different content, as it is
not
reflected in the cached object. - exact_
match bool - When enabled,
parameters
needs to match exactly. Keep disabled to match string prefixes. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- parameters Sequence[str]
- 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.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior String
- Configures how sets of query string parameters translate to cache keys. Be careful not to ignore any parameters that result in substantially different content, as it is
not
reflected in the cached object. - exact
Match Boolean - When enabled,
parameters
needs to match exactly. Keep disabled to match string prefixes. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- parameters List<String>
- 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.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCacheKeyRewrite
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Purge
Key string - Specifies the new cache key path as an alphanumeric value.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Purge
Key string - Specifies the new cache key path as an alphanumeric value.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- purge
Key String - Specifies the new cache key path as an alphanumeric value.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- purge
Key string - Specifies the new cache key path as an alphanumeric value.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- purge_
key str - Specifies the new cache key path as an alphanumeric value.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- purge
Key String - Specifies the new cache key path as an alphanumeric value.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCachePost
- Enabled bool
- Enables caching of POST responses.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Use
Body string - Define how and whether to use the POST message body as a cache key.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables caching of POST responses.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Use
Body string - Define how and whether to use the POST message body as a cache key.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables caching of POST responses.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- use
Body String - Define how and whether to use the POST message body as a cache key.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables caching of POST responses.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- use
Body string - Define how and whether to use the POST message body as a cache key.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables caching of POST responses.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- use_
body str - Define how and whether to use the POST message body as a cache key.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables caching of POST responses.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- use
Body String - Define how and whether to use the POST message body as a cache key.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCacheRedirect
- Enabled string
- Enables the redirect caching behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled string
- Enables the redirect caching behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- Enables the redirect caching behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled string
- Enables the redirect caching behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled str
- Enables the redirect caching behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- Enables the redirect caching behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCacheTag
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Tag string
- Specifies the cache tag you want to add to your cached content. A cache tag is only added when the object is first added to cache. A single cache tag can't exceed 128 characters and can only include alphanumeric characters, plus this class of characters:
[!#$%'+./^_`|~-]
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Tag string
- Specifies the cache tag you want to add to your cached content. A cache tag is only added when the object is first added to cache. A single cache tag can't exceed 128 characters and can only include alphanumeric characters, plus this class of characters:
[!#$%'+./^_`|~-]
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- tag String
- Specifies the cache tag you want to add to your cached content. A cache tag is only added when the object is first added to cache. A single cache tag can't exceed 128 characters and can only include alphanumeric characters, plus this class of characters:
[!#$%'+./^_`|~-]
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- tag string
- Specifies the cache tag you want to add to your cached content. A cache tag is only added when the object is first added to cache. A single cache tag can't exceed 128 characters and can only include alphanumeric characters, plus this class of characters:
[!#$%'+./^_`|~-]
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- tag str
- Specifies the cache tag you want to add to your cached content. A cache tag is only added when the object is first added to cache. A single cache tag can't exceed 128 characters and can only include alphanumeric characters, plus this class of characters:
[!#$%'+./^_`|~-]
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- tag String
- Specifies the cache tag you want to add to your cached content. A cache tag is only added when the object is first added to cache. A single cache tag can't exceed 128 characters and can only include alphanumeric characters, plus this class of characters:
[!#$%'+./^_`|~-]
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCacheTagVisible
- Behavior string
- Specifies when to include the
Edge-Cache-Tag
in responses. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Behavior string
- Specifies when to include the
Edge-Cache-Tag
in responses. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior String
- Specifies when to include the
Edge-Cache-Tag
in responses. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior string
- Specifies when to include the
Edge-Cache-Tag
in responses. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior str
- Specifies when to include the
Edge-Cache-Tag
in responses. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior String
- Specifies when to include the
Edge-Cache-Tag
in responses. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCaching
- Behavior string
- Specify the caching option.
- Cache
Control stringDirectives - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cacheability
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Default
Ttl string - Set the
MAX_AGE
header for the cached content. - Enhanced
Rfc boolSupport - This enables honoring particular
Cache-Control
header directives from the origin. Supports all officialRFC 7234
directives except forno-transform
. - Expiration
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Honor
Max boolAge - This instructs edge servers to cache the object for a length of time set by the
max-age
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - Honor
Must boolRevalidate - This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
- Honor
No boolCache - With the
no-cache
directive present in the response, this instructs edge servers to validate or refetch the response for each request. Effectively, set the time to livettl
to zero seconds. - Honor
No boolStore - Instructs edge servers not to cache the response when the origin response includes the
no-store
directive. - Honor
Private bool - Instructs edge servers not to cache the response when the origin response includes the
private
directive. - Honor
Proxy boolRevalidate - With the
proxy-revalidate
directive present in the response, this instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests. - Honor
SMaxage bool - Instructs edge servers to cache the object for a length of time set by the
s-maxage
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Must
Revalidate bool - 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.
- Revalidation
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Ttl string
- The maximum time content may remain cached. Setting the value to
0
is the same as setting ano-cache
header, which forces content to revalidate. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Behavior string
- Specify the caching option.
- Cache
Control stringDirectives - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cacheability
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Default
Ttl string - Set the
MAX_AGE
header for the cached content. - Enhanced
Rfc boolSupport - This enables honoring particular
Cache-Control
header directives from the origin. Supports all officialRFC 7234
directives except forno-transform
. - Expiration
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Honor
Max boolAge - This instructs edge servers to cache the object for a length of time set by the
max-age
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - Honor
Must boolRevalidate - This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
- Honor
No boolCache - With the
no-cache
directive present in the response, this instructs edge servers to validate or refetch the response for each request. Effectively, set the time to livettl
to zero seconds. - Honor
No boolStore - Instructs edge servers not to cache the response when the origin response includes the
no-store
directive. - Honor
Private bool - Instructs edge servers not to cache the response when the origin response includes the
private
directive. - Honor
Proxy boolRevalidate - With the
proxy-revalidate
directive present in the response, this instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests. - Honor
SMaxage bool - Instructs edge servers to cache the object for a length of time set by the
s-maxage
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Must
Revalidate bool - 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.
- Revalidation
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Ttl string
- The maximum time content may remain cached. Setting the value to
0
is the same as setting ano-cache
header, which forces content to revalidate. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior String
- Specify the caching option.
- cache
Control StringDirectives - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cacheability
Settings String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- default
Ttl String - Set the
MAX_AGE
header for the cached content. - enhanced
Rfc BooleanSupport - This enables honoring particular
Cache-Control
header directives from the origin. Supports all officialRFC 7234
directives except forno-transform
. - expiration
Settings String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- honor
Max BooleanAge - This instructs edge servers to cache the object for a length of time set by the
max-age
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - honor
Must BooleanRevalidate - This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
- honor
No BooleanCache - With the
no-cache
directive present in the response, this instructs edge servers to validate or refetch the response for each request. Effectively, set the time to livettl
to zero seconds. - honor
No BooleanStore - Instructs edge servers not to cache the response when the origin response includes the
no-store
directive. - honor
Private Boolean - Instructs edge servers not to cache the response when the origin response includes the
private
directive. - honor
Proxy BooleanRevalidate - With the
proxy-revalidate
directive present in the response, this instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests. - honor
SMaxage Boolean - Instructs edge servers to cache the object for a length of time set by the
s-maxage
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- must
Revalidate 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.
- revalidation
Settings String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- ttl String
- The maximum time content may remain cached. Setting the value to
0
is the same as setting ano-cache
header, which forces content to revalidate. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior string
- Specify the caching option.
- cache
Control stringDirectives - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cacheability
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- default
Ttl string - Set the
MAX_AGE
header for the cached content. - enhanced
Rfc booleanSupport - This enables honoring particular
Cache-Control
header directives from the origin. Supports all officialRFC 7234
directives except forno-transform
. - expiration
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- honor
Max booleanAge - This instructs edge servers to cache the object for a length of time set by the
max-age
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - honor
Must booleanRevalidate - This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
- honor
No booleanCache - With the
no-cache
directive present in the response, this instructs edge servers to validate or refetch the response for each request. Effectively, set the time to livettl
to zero seconds. - honor
No booleanStore - Instructs edge servers not to cache the response when the origin response includes the
no-store
directive. - honor
Private boolean - Instructs edge servers not to cache the response when the origin response includes the
private
directive. - honor
Proxy booleanRevalidate - With the
proxy-revalidate
directive present in the response, this instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests. - honor
SMaxage boolean - Instructs edge servers to cache the object for a length of time set by the
s-maxage
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- must
Revalidate 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.
- revalidation
Settings string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- ttl string
- The maximum time content may remain cached. Setting the value to
0
is the same as setting ano-cache
header, which forces content to revalidate. - uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior str
- Specify the caching option.
- cache_
control_ strdirectives - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cacheability_
settings str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- default_
ttl str - Set the
MAX_AGE
header for the cached content. - enhanced_
rfc_ boolsupport - This enables honoring particular
Cache-Control
header directives from the origin. Supports all officialRFC 7234
directives except forno-transform
. - expiration_
settings str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- honor_
max_ boolage - This instructs edge servers to cache the object for a length of time set by the
max-age
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - honor_
must_ boolrevalidate - This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
- honor_
no_ boolcache - With the
no-cache
directive present in the response, this instructs edge servers to validate or refetch the response for each request. Effectively, set the time to livettl
to zero seconds. - honor_
no_ boolstore - Instructs edge servers not to cache the response when the origin response includes the
no-store
directive. - honor_
private bool - Instructs edge servers not to cache the response when the origin response includes the
private
directive. - honor_
proxy_ boolrevalidate - With the
proxy-revalidate
directive present in the response, this instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests. - honor_
s_ boolmaxage - Instructs edge servers to cache the object for a length of time set by the
s-maxage
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- must_
revalidate bool - 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.
- revalidation_
settings str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- ttl str
- The maximum time content may remain cached. Setting the value to
0
is the same as setting ano-cache
header, which forces content to revalidate. - uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior String
- Specify the caching option.
- cache
Control StringDirectives - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cacheability
Settings String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- default
Ttl String - Set the
MAX_AGE
header for the cached content. - enhanced
Rfc BooleanSupport - This enables honoring particular
Cache-Control
header directives from the origin. Supports all officialRFC 7234
directives except forno-transform
. - expiration
Settings String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- honor
Max BooleanAge - This instructs edge servers to cache the object for a length of time set by the
max-age
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - honor
Must BooleanRevalidate - This instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests.
- honor
No BooleanCache - With the
no-cache
directive present in the response, this instructs edge servers to validate or refetch the response for each request. Effectively, set the time to livettl
to zero seconds. - honor
No BooleanStore - Instructs edge servers not to cache the response when the origin response includes the
no-store
directive. - honor
Private Boolean - Instructs edge servers not to cache the response when the origin response includes the
private
directive. - honor
Proxy BooleanRevalidate - With the
proxy-revalidate
directive present in the response, this instructs edge servers to successfully revalidate with the origin server before using stale objects in the cache to satisfy new requests. - honor
SMaxage Boolean - Instructs edge servers to cache the object for a length of time set by the
s-maxage
directive in the response. When present in the origin response, this directive takes precedence over themax-age
directive and thedefaultTtl
setting. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- must
Revalidate 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.
- revalidation
Settings String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- ttl String
- The maximum time content may remain cached. Setting the value to
0
is the same as setting ano-cache
header, which forces content to revalidate. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCentralAuthorization
- Enabled bool
- Enables the centralized authorization behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the centralized authorization behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the centralized authorization behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the centralized authorization behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the centralized authorization behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the centralized authorization behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorChaseRedirects
- Enabled bool
- Allows edge servers to chase redirects.
- Limit string
- Specifies, as a string, the maximum number of redirects to follow.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Serve404 bool
- Once the redirect
limit
is reached, enabling this option serves an HTTP404
(Not Found) error instead of the last redirect. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Allows edge servers to chase redirects.
- Limit string
- Specifies, as a string, the maximum number of redirects to follow.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Serve404 bool
- Once the redirect
limit
is reached, enabling this option serves an HTTP404
(Not Found) error instead of the last redirect. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows edge servers to chase redirects.
- limit String
- Specifies, as a string, the maximum number of redirects to follow.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- serve404 Boolean
- Once the redirect
limit
is reached, enabling this option serves an HTTP404
(Not Found) error instead of the last redirect. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Allows edge servers to chase redirects.
- limit string
- Specifies, as a string, the maximum number of redirects to follow.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- serve404 boolean
- Once the redirect
limit
is reached, enabling this option serves an HTTP404
(Not Found) error instead of the last redirect. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Allows edge servers to chase redirects.
- limit str
- Specifies, as a string, the maximum number of redirects to follow.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- serve404 bool
- Once the redirect
limit
is reached, enabling this option serves an HTTP404
(Not Found) error instead of the last redirect. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows edge servers to chase redirects.
- limit String
- Specifies, as a string, the maximum number of redirects to follow.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- serve404 Boolean
- Once the redirect
limit
is reached, enabling this option serves an HTTP404
(Not Found) error instead of the last redirect. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorClientCharacteristics
- Country string
- Specifies the client request's geographic region.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Country string
- Specifies the client request's geographic region.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- country String
- Specifies the client request's geographic region.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- country string
- Specifies the client request's geographic region.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- country str
- Specifies the client request's geographic region.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- country String
- Specifies the client request's geographic region.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCloudInterconnects
- Cloud
Locations List<string> - Specifies the geographical locations of your cloud origin. You should enable Cloud Interconnects only if your origin is in one of these locations, since GCP doesn't provide a discount for egress traffic for any other regions.
- Enabled bool
- Channels the traffic to maximize the egress discount at the origin.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Cloud
Locations []string - Specifies the geographical locations of your cloud origin. You should enable Cloud Interconnects only if your origin is in one of these locations, since GCP doesn't provide a discount for egress traffic for any other regions.
- Enabled bool
- Channels the traffic to maximize the egress discount at the origin.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloud
Locations List<String> - Specifies the geographical locations of your cloud origin. You should enable Cloud Interconnects only if your origin is in one of these locations, since GCP doesn't provide a discount for egress traffic for any other regions.
- enabled Boolean
- Channels the traffic to maximize the egress discount at the origin.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloud
Locations string[] - Specifies the geographical locations of your cloud origin. You should enable Cloud Interconnects only if your origin is in one of these locations, since GCP doesn't provide a discount for egress traffic for any other regions.
- enabled boolean
- Channels the traffic to maximize the egress discount at the origin.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloud_
locations Sequence[str] - Specifies the geographical locations of your cloud origin. You should enable Cloud Interconnects only if your origin is in one of these locations, since GCP doesn't provide a discount for egress traffic for any other regions.
- enabled bool
- Channels the traffic to maximize the egress discount at the origin.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloud
Locations List<String> - Specifies the geographical locations of your cloud origin. You should enable Cloud Interconnects only if your origin is in one of these locations, since GCP doesn't provide a discount for egress traffic for any other regions.
- enabled Boolean
- Channels the traffic to maximize the egress discount at the origin.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapper
- Enabled bool
- Enables Cloud Wrapper behavior.
- Location string
- The location you want to distribute your Cloud Wrapper cache space to. This behavior allows all locations configured in your Cloud Wrapper configuration.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables Cloud Wrapper behavior.
- Location string
- The location you want to distribute your Cloud Wrapper cache space to. This behavior allows all locations configured in your Cloud Wrapper configuration.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables Cloud Wrapper behavior.
- location String
- The location you want to distribute your Cloud Wrapper cache space to. This behavior allows all locations configured in your Cloud Wrapper configuration.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables Cloud Wrapper behavior.
- location string
- The location you want to distribute your Cloud Wrapper cache space to. This behavior allows all locations configured in your Cloud Wrapper configuration.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables Cloud Wrapper behavior.
- location str
- The location you want to distribute your Cloud Wrapper cache space to. This behavior allows all locations configured in your Cloud Wrapper configuration.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables Cloud Wrapper behavior.
- location String
- The location you want to distribute your Cloud Wrapper cache space to. This behavior allows all locations configured in your Cloud Wrapper configuration.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCloudWrapperAdvanced
- Custom
Failover stringMap - Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- Enabled bool
- Enables failover for Cloud Wrapper.
- Failover
Map string - Specifies the failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Custom
Failover stringMap - Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- Enabled bool
- Enables failover for Cloud Wrapper.
- Failover
Map string - Specifies the failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Failover StringMap - Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- enabled Boolean
- Enables failover for Cloud Wrapper.
- failover
Map String - Specifies the failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Failover stringMap - Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- enabled boolean
- Enables failover for Cloud Wrapper.
- failover
Map string - Specifies the failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom_
failover_ strmap - Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- enabled bool
- Enables failover for Cloud Wrapper.
- failover_
map str - Specifies the failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Failover StringMap - Specifies the custom failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- enabled Boolean
- Enables failover for Cloud Wrapper.
- failover
Map String - Specifies the failover map to handle Cloud Wrapper failures. Contact your account representative for more information.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorConditionalOrigin
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Origin
Id string - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Origin
Id string - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origin
Id String - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origin
Id string - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origin_
id str - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origin
Id String - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorConstructResponse
- Body string
- HTML response of up to 2000 characters to send to the end-user client.
- Enabled bool
- Serves the custom response.
- Force
Eviction bool - For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to
false
. - Ignore
Purge bool - Whether to ignore the custom response when purging.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Response
Code int - The HTTP response code to send to the end-user client.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Body string
- HTML response of up to 2000 characters to send to the end-user client.
- Enabled bool
- Serves the custom response.
- Force
Eviction bool - For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to
false
. - Ignore
Purge bool - Whether to ignore the custom response when purging.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Response
Code int - The HTTP response code to send to the end-user client.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- body String
- HTML response of up to 2000 characters to send to the end-user client.
- enabled Boolean
- Serves the custom response.
- force
Eviction Boolean - For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to
false
. - ignore
Purge Boolean - Whether to ignore the custom response when purging.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- response
Code Integer - The HTTP response code to send to the end-user client.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- body string
- HTML response of up to 2000 characters to send to the end-user client.
- enabled boolean
- Serves the custom response.
- force
Eviction boolean - For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to
false
. - ignore
Purge boolean - Whether to ignore the custom response when purging.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- response
Code number - The HTTP response code to send to the end-user client.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- body str
- HTML response of up to 2000 characters to send to the end-user client.
- enabled bool
- Serves the custom response.
- force_
eviction bool - For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to
false
. - ignore_
purge bool - Whether to ignore the custom response when purging.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- response_
code int - The HTTP response code to send to the end-user client.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- body String
- HTML response of up to 2000 characters to send to the end-user client.
- enabled Boolean
- Serves the custom response.
- force
Eviction Boolean - For GET requests from clients, this forces edge servers to evict the underlying object from cache. Defaults to
false
. - ignore
Purge Boolean - Whether to ignore the custom response when purging.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- response
Code Number - The HTTP response code to send to the end-user client.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristics
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the type of content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Object
Size string - Optimize based on the size of the object retrieved from the origin.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the type of content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Object
Size string - Optimize based on the size of the object retrieved from the origin.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the type of content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size String - Optimize based on the size of the object retrieved from the origin.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size string - Optimize based on the total size of the content library delivered.
- content
Type string - Optimize based on the type of content.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size string - Optimize based on the size of the object retrieved from the origin.
- popularity
Distribution string - Optimize based on the content's expected popularity.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog_
size str - Optimize based on the total size of the content library delivered.
- content_
type str - Optimize based on the type of content.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object_
size str - Optimize based on the size of the object retrieved from the origin.
- popularity_
distribution str - Optimize based on the content's expected popularity.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the type of content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size String - Optimize based on the size of the object retrieved from the origin.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsAmd
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the quality of media content.
- Dash bool
- Enable delivery of DASH media.
- Hds bool
- Enable delivery of HDS media.
- Hls bool
- Enable delivery of HLS media.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Segment
Duration stringDash - Specifies the duration of individual segments.
- Segment
Duration intDash Custom - Customizes the number of seconds for the segment.
- Segment
Duration stringHds - Specifies the duration of individual fragments.
- Segment
Duration intHds Custom - Customizes the number of seconds for the fragment.
- Segment
Duration stringHls - Specifies the duration of individual segments.
- Segment
Duration doubleHls Custom - Customizes the number of seconds for the segment.
- Segment
Duration stringSmooth - Specifies the duration of individual fragments.
- Segment
Duration doubleSmooth Custom - Customizes the number of seconds for the fragment.
- Segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- Smooth bool
- Enable delivery of Smooth media.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the quality of media content.
- Dash bool
- Enable delivery of DASH media.
- Hds bool
- Enable delivery of HDS media.
- Hls bool
- Enable delivery of HLS media.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Segment
Duration stringDash - Specifies the duration of individual segments.
- Segment
Duration intDash Custom - Customizes the number of seconds for the segment.
- Segment
Duration stringHds - Specifies the duration of individual fragments.
- Segment
Duration intHds Custom - Customizes the number of seconds for the fragment.
- Segment
Duration stringHls - Specifies the duration of individual segments.
- Segment
Duration float64Hls Custom - Customizes the number of seconds for the segment.
- Segment
Duration stringSmooth - Specifies the duration of individual fragments.
- Segment
Duration float64Smooth Custom - Customizes the number of seconds for the fragment.
- Segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- Smooth bool
- Enable delivery of Smooth media.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the quality of media content.
- dash Boolean
- Enable delivery of DASH media.
- hds Boolean
- Enable delivery of HDS media.
- hls Boolean
- Enable delivery of HLS media.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- segment
Duration StringDash - Specifies the duration of individual segments.
- segment
Duration IntegerDash Custom - Customizes the number of seconds for the segment.
- segment
Duration StringHds - Specifies the duration of individual fragments.
- segment
Duration IntegerHds Custom - Customizes the number of seconds for the fragment.
- segment
Duration StringHls - Specifies the duration of individual segments.
- segment
Duration DoubleHls Custom - Customizes the number of seconds for the segment.
- segment
Duration StringSmooth - Specifies the duration of individual fragments.
- segment
Duration DoubleSmooth Custom - Customizes the number of seconds for the fragment.
- segment
Size StringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size StringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth Boolean
- Enable delivery of Smooth media.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size string - Optimize based on the total size of the content library delivered.
- content
Type string - Optimize based on the quality of media content.
- dash boolean
- Enable delivery of DASH media.
- hds boolean
- Enable delivery of HDS media.
- hls boolean
- Enable delivery of HLS media.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution string - Optimize based on the content's expected popularity.
- segment
Duration stringDash - Specifies the duration of individual segments.
- segment
Duration numberDash Custom - Customizes the number of seconds for the segment.
- segment
Duration stringHds - Specifies the duration of individual fragments.
- segment
Duration numberHds Custom - Customizes the number of seconds for the fragment.
- segment
Duration stringHls - Specifies the duration of individual segments.
- segment
Duration numberHls Custom - Customizes the number of seconds for the segment.
- segment
Duration stringSmooth - Specifies the duration of individual fragments.
- segment
Duration numberSmooth Custom - Customizes the number of seconds for the fragment.
- segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth boolean
- Enable delivery of Smooth media.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog_
size str - Optimize based on the total size of the content library delivered.
- content_
type str - Optimize based on the quality of media content.
- dash bool
- Enable delivery of DASH media.
- hds bool
- Enable delivery of HDS media.
- hls bool
- Enable delivery of HLS media.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity_
distribution str - Optimize based on the content's expected popularity.
- segment_
duration_ strdash - Specifies the duration of individual segments.
- segment_
duration_ intdash_ custom - Customizes the number of seconds for the segment.
- segment_
duration_ strhds - Specifies the duration of individual fragments.
- segment_
duration_ inthds_ custom - Customizes the number of seconds for the fragment.
- segment_
duration_ strhls - Specifies the duration of individual segments.
- segment_
duration_ floathls_ custom - Customizes the number of seconds for the segment.
- segment_
duration_ strsmooth - Specifies the duration of individual fragments.
- segment_
duration_ floatsmooth_ custom - Customizes the number of seconds for the fragment.
- segment_
size_ strdash - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strhds - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strhls - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strsmooth - Specifies the size of the media object retrieved from the origin.
- smooth bool
- Enable delivery of Smooth media.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the quality of media content.
- dash Boolean
- Enable delivery of DASH media.
- hds Boolean
- Enable delivery of HDS media.
- hls Boolean
- Enable delivery of HLS media.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- segment
Duration StringDash - Specifies the duration of individual segments.
- segment
Duration NumberDash Custom - Customizes the number of seconds for the segment.
- segment
Duration StringHds - Specifies the duration of individual fragments.
- segment
Duration NumberHds Custom - Customizes the number of seconds for the fragment.
- segment
Duration StringHls - Specifies the duration of individual segments.
- segment
Duration NumberHls Custom - Customizes the number of seconds for the segment.
- segment
Duration StringSmooth - Specifies the duration of individual fragments.
- segment
Duration NumberSmooth Custom - Customizes the number of seconds for the fragment.
- segment
Size StringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size StringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth Boolean
- Enable delivery of Smooth media.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsDd
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the type of content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Object
Size string - Optimize based on the size of the object retrieved from the origin.
- Optimize
Option bool - Optimizes the delivery throughput and download times for large files.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the type of content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Object
Size string - Optimize based on the size of the object retrieved from the origin.
- Optimize
Option bool - Optimizes the delivery throughput and download times for large files.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the type of content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size String - Optimize based on the size of the object retrieved from the origin.
- optimize
Option Boolean - Optimizes the delivery throughput and download times for large files.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size string - Optimize based on the total size of the content library delivered.
- content
Type string - Optimize based on the type of content.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size string - Optimize based on the size of the object retrieved from the origin.
- optimize
Option boolean - Optimizes the delivery throughput and download times for large files.
- popularity
Distribution string - Optimize based on the content's expected popularity.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog_
size str - Optimize based on the total size of the content library delivered.
- content_
type str - Optimize based on the type of content.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object_
size str - Optimize based on the size of the object retrieved from the origin.
- optimize_
option bool - Optimizes the delivery throughput and download times for large files.
- popularity_
distribution str - Optimize based on the content's expected popularity.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the type of content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size String - Optimize based on the size of the object retrieved from the origin.
- optimize
Option Boolean - Optimizes the delivery throughput and download times for large files.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLargeFile
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the type of content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Object
Size string - Optimize based on the size of the object retrieved from the origin.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the type of content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Object
Size string - Optimize based on the size of the object retrieved from the origin.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the type of content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size String - Optimize based on the size of the object retrieved from the origin.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size string - Optimize based on the total size of the content library delivered.
- content
Type string - Optimize based on the type of content.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size string - Optimize based on the size of the object retrieved from the origin.
- popularity
Distribution string - Optimize based on the content's expected popularity.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog_
size str - Optimize based on the total size of the content library delivered.
- content_
type str - Optimize based on the type of content.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object_
size str - Optimize based on the size of the object retrieved from the origin.
- popularity_
distribution str - Optimize based on the content's expected popularity.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the type of content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size String - Optimize based on the size of the object retrieved from the origin.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdLive
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the quality of media content.
- Dash bool
- Enable delivery of DASH media.
- Hds bool
- Enable delivery of HDS media.
- Hls bool
- Enable delivery of HLS media.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Segment
Duration stringDash - Specifies the duration of individual segments.
- Segment
Duration stringHds - Specifies the duration of individual fragments.
- Segment
Duration stringHls - Specifies the duration of individual segments.
- Segment
Duration stringSmooth - Specifies the duration of individual fragments.
- Segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- Smooth bool
- Enable delivery of Smooth media.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the quality of media content.
- Dash bool
- Enable delivery of DASH media.
- Hds bool
- Enable delivery of HDS media.
- Hls bool
- Enable delivery of HLS media.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Segment
Duration stringDash - Specifies the duration of individual segments.
- Segment
Duration stringHds - Specifies the duration of individual fragments.
- Segment
Duration stringHls - Specifies the duration of individual segments.
- Segment
Duration stringSmooth - Specifies the duration of individual fragments.
- Segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- Smooth bool
- Enable delivery of Smooth media.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the quality of media content.
- dash Boolean
- Enable delivery of DASH media.
- hds Boolean
- Enable delivery of HDS media.
- hls Boolean
- Enable delivery of HLS media.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- segment
Duration StringDash - Specifies the duration of individual segments.
- segment
Duration StringHds - Specifies the duration of individual fragments.
- segment
Duration StringHls - Specifies the duration of individual segments.
- segment
Duration StringSmooth - Specifies the duration of individual fragments.
- segment
Size StringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size StringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth Boolean
- Enable delivery of Smooth media.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size string - Optimize based on the total size of the content library delivered.
- content
Type string - Optimize based on the quality of media content.
- dash boolean
- Enable delivery of DASH media.
- hds boolean
- Enable delivery of HDS media.
- hls boolean
- Enable delivery of HLS media.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution string - Optimize based on the content's expected popularity.
- segment
Duration stringDash - Specifies the duration of individual segments.
- segment
Duration stringHds - Specifies the duration of individual fragments.
- segment
Duration stringHls - Specifies the duration of individual segments.
- segment
Duration stringSmooth - Specifies the duration of individual fragments.
- segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth boolean
- Enable delivery of Smooth media.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog_
size str - Optimize based on the total size of the content library delivered.
- content_
type str - Optimize based on the quality of media content.
- dash bool
- Enable delivery of DASH media.
- hds bool
- Enable delivery of HDS media.
- hls bool
- Enable delivery of HLS media.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity_
distribution str - Optimize based on the content's expected popularity.
- segment_
duration_ strdash - Specifies the duration of individual segments.
- segment_
duration_ strhds - Specifies the duration of individual fragments.
- segment_
duration_ strhls - Specifies the duration of individual segments.
- segment_
duration_ strsmooth - Specifies the duration of individual fragments.
- segment_
size_ strdash - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strhds - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strhls - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strsmooth - Specifies the size of the media object retrieved from the origin.
- smooth bool
- Enable delivery of Smooth media.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the quality of media content.
- dash Boolean
- Enable delivery of DASH media.
- hds Boolean
- Enable delivery of HDS media.
- hls Boolean
- Enable delivery of HLS media.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- segment
Duration StringDash - Specifies the duration of individual segments.
- segment
Duration StringHds - Specifies the duration of individual fragments.
- segment
Duration StringHls - Specifies the duration of individual segments.
- segment
Duration StringSmooth - Specifies the duration of individual fragments.
- segment
Size StringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size StringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth Boolean
- Enable delivery of Smooth media.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorContentCharacteristicsWsdVod
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the quality of media content.
- Dash bool
- Enable delivery of DASH media.
- Hds bool
- Enable delivery of HDS media.
- Hls bool
- Enable delivery of HLS media.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Segment
Duration stringDash - Specifies the duration of individual segments.
- Segment
Duration stringHds - Specifies the duration of individual fragments.
- Segment
Duration stringHls - Specifies the duration of individual segments.
- Segment
Duration stringSmooth - Specifies the duration of individual fragments.
- Segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- Smooth bool
- Enable delivery of Smooth media.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Catalog
Size string - Optimize based on the total size of the content library delivered.
- Content
Type string - Optimize based on the quality of media content.
- Dash bool
- Enable delivery of DASH media.
- Hds bool
- Enable delivery of HDS media.
- Hls bool
- Enable delivery of HLS media.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Popularity
Distribution string - Optimize based on the content's expected popularity.
- Segment
Duration stringDash - Specifies the duration of individual segments.
- Segment
Duration stringHds - Specifies the duration of individual fragments.
- Segment
Duration stringHls - Specifies the duration of individual segments.
- Segment
Duration stringSmooth - Specifies the duration of individual fragments.
- Segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- Segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- Smooth bool
- Enable delivery of Smooth media.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the quality of media content.
- dash Boolean
- Enable delivery of DASH media.
- hds Boolean
- Enable delivery of HDS media.
- hls Boolean
- Enable delivery of HLS media.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- segment
Duration StringDash - Specifies the duration of individual segments.
- segment
Duration StringHds - Specifies the duration of individual fragments.
- segment
Duration StringHls - Specifies the duration of individual segments.
- segment
Duration StringSmooth - Specifies the duration of individual fragments.
- segment
Size StringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size StringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth Boolean
- Enable delivery of Smooth media.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size string - Optimize based on the total size of the content library delivered.
- content
Type string - Optimize based on the quality of media content.
- dash boolean
- Enable delivery of DASH media.
- hds boolean
- Enable delivery of HDS media.
- hls boolean
- Enable delivery of HLS media.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution string - Optimize based on the content's expected popularity.
- segment
Duration stringDash - Specifies the duration of individual segments.
- segment
Duration stringHds - Specifies the duration of individual fragments.
- segment
Duration stringHls - Specifies the duration of individual segments.
- segment
Duration stringSmooth - Specifies the duration of individual fragments.
- segment
Size stringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size stringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size stringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size stringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth boolean
- Enable delivery of Smooth media.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog_
size str - Optimize based on the total size of the content library delivered.
- content_
type str - Optimize based on the quality of media content.
- dash bool
- Enable delivery of DASH media.
- hds bool
- Enable delivery of HDS media.
- hls bool
- Enable delivery of HLS media.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity_
distribution str - Optimize based on the content's expected popularity.
- segment_
duration_ strdash - Specifies the duration of individual segments.
- segment_
duration_ strhds - Specifies the duration of individual fragments.
- segment_
duration_ strhls - Specifies the duration of individual segments.
- segment_
duration_ strsmooth - Specifies the duration of individual fragments.
- segment_
size_ strdash - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strhds - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strhls - Specifies the size of the media object retrieved from the origin.
- segment_
size_ strsmooth - Specifies the size of the media object retrieved from the origin.
- smooth bool
- Enable delivery of Smooth media.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- catalog
Size String - Optimize based on the total size of the content library delivered.
- content
Type String - Optimize based on the quality of media content.
- dash Boolean
- Enable delivery of DASH media.
- hds Boolean
- Enable delivery of HDS media.
- hls Boolean
- Enable delivery of HLS media.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- popularity
Distribution String - Optimize based on the content's expected popularity.
- segment
Duration StringDash - Specifies the duration of individual segments.
- segment
Duration StringHds - Specifies the duration of individual fragments.
- segment
Duration StringHls - Specifies the duration of individual segments.
- segment
Duration StringSmooth - Specifies the duration of individual fragments.
- segment
Size StringDash - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHds - Specifies the size of the media object retrieved from the origin.
- segment
Size StringHls - Specifies the size of the media object retrieved from the origin.
- segment
Size StringSmooth - Specifies the size of the media object retrieved from the origin.
- smooth Boolean
- Enable delivery of Smooth media.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorContentPrePosition
- Enabled bool
- Enables the Content PrePosition behavior.
- First
Location string - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Second
Location string - Source
Type string - Targets string
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the Content PrePosition behavior.
- First
Location string - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Second
Location string - Source
Type string - Targets string
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Content PrePosition behavior.
- first
Location String - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- second
Location String - source
Type String - targets String
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the Content PrePosition behavior.
- first
Location string - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- second
Location string - source
Type string - targets string
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the Content PrePosition behavior.
- first_
location str - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- second_
location str - source_
type str - targets str
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Content PrePosition behavior.
- first
Location String - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- second
Location String - source
Type String - targets String
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorContentTargetingProtection
- Countries List<string>
- Specifies a set of two-character ISO 3166 country codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - Dmas List<string>
- Specifies the set of Designated Market Area codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - Enable
Geo boolProtection - When enabled, verifies IP addresses are unique to specific geographic regions.
- Enable
Geo boolRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- Enable
Ip boolProtection - Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
- Enable
Ip boolRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- Enable
Referrer boolProtection - Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
- Enable
Referrer boolRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- Enabled bool
- Enables the Content Targeting feature.
- Geo
Protection stringMode - Specifies how to handle requests.
- Geo
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Geo
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- Ip
Addresses List<string> - Specify a set of IP addresses or CIDR blocks to allow or deny.
- Ip
Protection stringMode - Specifies how to handle requests.
- Ip
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Ip
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Override
Ip List<string>Addresses - Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
- Referrer
Domains List<string> - Specifies the set of domains from which to allow or deny traffic.
- Referrer
Protection stringMode - Specify the action to take.
- Referrer
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Referrer
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- Regions List<string>
- Specifies a set of ISO 3166-2 regional codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Countries []string
- Specifies a set of two-character ISO 3166 country codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - Dmas []string
- Specifies the set of Designated Market Area codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - Enable
Geo boolProtection - When enabled, verifies IP addresses are unique to specific geographic regions.
- Enable
Geo boolRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- Enable
Ip boolProtection - Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
- Enable
Ip boolRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- Enable
Referrer boolProtection - Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
- Enable
Referrer boolRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- Enabled bool
- Enables the Content Targeting feature.
- Geo
Protection stringMode - Specifies how to handle requests.
- Geo
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Geo
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- Ip
Addresses []string - Specify a set of IP addresses or CIDR blocks to allow or deny.
- Ip
Protection stringMode - Specifies how to handle requests.
- Ip
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Ip
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Override
Ip []stringAddresses - Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
- Referrer
Domains []string - Specifies the set of domains from which to allow or deny traffic.
- Referrer
Protection stringMode - Specify the action to take.
- Referrer
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Referrer
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- Regions []string
- Specifies a set of ISO 3166-2 regional codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- countries List<String>
- Specifies a set of two-character ISO 3166 country codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - dmas List<String>
- Specifies the set of Designated Market Area codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - enable
Geo BooleanProtection - When enabled, verifies IP addresses are unique to specific geographic regions.
- enable
Geo BooleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enable
Ip BooleanProtection - Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
- enable
Ip BooleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enable
Referrer BooleanProtection - Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
- enable
Referrer BooleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enabled Boolean
- Enables the Content Targeting feature.
- geo
Protection StringMode - Specifies how to handle requests.
- geo
Protection StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- geo
Redirect StringUrl - This specifies the full URL to the redirect page for denied requests.
- ip
Addresses List<String> - Specify a set of IP addresses or CIDR blocks to allow or deny.
- ip
Protection StringMode - Specifies how to handle requests.
- ip
Protection StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- ip
Redirect StringUrl - This specifies the full URL to the redirect page for denied requests.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override
Ip List<String>Addresses - Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
- referrer
Domains List<String> - Specifies the set of domains from which to allow or deny traffic.
- referrer
Protection StringMode - Specify the action to take.
- referrer
Protection StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- referrer
Redirect StringUrl - This specifies the full URL to the redirect page for denied requests.
- regions List<String>
- Specifies a set of ISO 3166-2 regional codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- countries string[]
- Specifies a set of two-character ISO 3166 country codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - dmas string[]
- Specifies the set of Designated Market Area codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - enable
Geo booleanProtection - When enabled, verifies IP addresses are unique to specific geographic regions.
- enable
Geo booleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enable
Ip booleanProtection - Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
- enable
Ip booleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enable
Referrer booleanProtection - Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
- enable
Referrer booleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enabled boolean
- Enables the Content Targeting feature.
- geo
Protection stringMode - Specifies how to handle requests.
- geo
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- geo
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- ip
Addresses string[] - Specify a set of IP addresses or CIDR blocks to allow or deny.
- ip
Protection stringMode - Specifies how to handle requests.
- ip
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- ip
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override
Ip string[]Addresses - Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
- referrer
Domains string[] - Specifies the set of domains from which to allow or deny traffic.
- referrer
Protection stringMode - Specify the action to take.
- referrer
Protection stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- referrer
Redirect stringUrl - This specifies the full URL to the redirect page for denied requests.
- regions string[]
- Specifies a set of ISO 3166-2 regional codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- countries Sequence[str]
- Specifies a set of two-character ISO 3166 country codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - dmas Sequence[str]
- Specifies the set of Designated Market Area codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - enable_
geo_ boolprotection - When enabled, verifies IP addresses are unique to specific geographic regions.
- enable_
geo_ boolredirect_ on_ deny - When enabled, redirects denied requests rather than responding with an error code.
- enable_
ip_ boolprotection - Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
- enable_
ip_ boolredirect_ on_ deny - When enabled, redirects denied requests rather than responding with an error code.
- enable_
referrer_ boolprotection - Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
- enable_
referrer_ boolredirect_ on_ deny - When enabled, redirects denied requests rather than responding with an error code.
- enabled bool
- Enables the Content Targeting feature.
- geo_
protection_ strmode - Specifies how to handle requests.
- geo_
protection_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- geo_
redirect_ strurl - This specifies the full URL to the redirect page for denied requests.
- ip_
addresses Sequence[str] - Specify a set of IP addresses or CIDR blocks to allow or deny.
- ip_
protection_ strmode - Specifies how to handle requests.
- ip_
protection_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- ip_
redirect_ strurl - This specifies the full URL to the redirect page for denied requests.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override_
ip_ Sequence[str]addresses - Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
- referrer_
domains Sequence[str] - Specifies the set of domains from which to allow or deny traffic.
- referrer_
protection_ strmode - Specify the action to take.
- referrer_
protection_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- referrer_
redirect_ strurl - This specifies the full URL to the redirect page for denied requests.
- regions Sequence[str]
- Specifies a set of ISO 3166-2 regional codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- countries List<String>
- Specifies a set of two-character ISO 3166 country codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - dmas List<String>
- Specifies the set of Designated Market Area codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - enable
Geo BooleanProtection - When enabled, verifies IP addresses are unique to specific geographic regions.
- enable
Geo BooleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enable
Ip BooleanProtection - Allows you to control access to your content from specific sets of IP addresses and CIDR blocks.
- enable
Ip BooleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enable
Referrer BooleanProtection - Allows you allow traffic from certain referring websites, and disallow traffic from unauthorized sites that hijack those links.
- enable
Referrer BooleanRedirect On Deny - When enabled, redirects denied requests rather than responding with an error code.
- enabled Boolean
- Enables the Content Targeting feature.
- geo
Protection StringMode - Specifies how to handle requests.
- geo
Protection StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- geo
Redirect StringUrl - This specifies the full URL to the redirect page for denied requests.
- ip
Addresses List<String> - Specify a set of IP addresses or CIDR blocks to allow or deny.
- ip
Protection StringMode - Specifies how to handle requests.
- ip
Protection StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- ip
Redirect StringUrl - This specifies the full URL to the redirect page for denied requests.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override
Ip List<String>Addresses - Specify a set of IP addresses or CIDR blocks that exceptions to the set of included or excluded areas.
- referrer
Domains List<String> - Specifies the set of domains from which to allow or deny traffic.
- referrer
Protection StringMode - Specify the action to take.
- referrer
Protection StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- referrer
Redirect StringUrl - This specifies the full URL to the redirect page for denied requests.
- regions List<String>
- Specifies a set of ISO 3166-2 regional codes from which to allow or deny traffic. See
EdgeScape Data Codes
for a list. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCorsSupport
- Allow
Credentials bool - Accepts requests made using credentials, like cookies or TLS client certificates.
- Allow
Headers string - In responses to preflight requests, defines which headers to allow when making the actual request.
- Allow
Origins string - In responses to preflight requests, sets which origin hostnames to accept requests from.
- Enabled bool
- Enables CORS feature.
- Expose
Headers List<string> - In responses to preflight requests, lists names of headers that clients can access. By default, clients can access the following simple response headers:
Cache-Control
,Content-Language
,Content-Type
,Expires
,Last-Modified
, andPragma
. You can add other header names to make them accessible to clients. - Headers List<string>
- Defines the supported request headers.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Methods List<string>
- Specifies any combination of the following methods:
DELETE
,GET
,PATCH
,POST
, andPUT
that are allowed when accessing the resource from an external domain. - Origins List<string>
- Defines the origin hostnames to accept requests from. The hostnames that you enter need to start with
http
orhttps
. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications. - Preflight
Max stringAge - Defines the number of seconds that the browser should cache the response to a preflight request.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Allow
Credentials bool - Accepts requests made using credentials, like cookies or TLS client certificates.
- Allow
Headers string - In responses to preflight requests, defines which headers to allow when making the actual request.
- Allow
Origins string - In responses to preflight requests, sets which origin hostnames to accept requests from.
- Enabled bool
- Enables CORS feature.
- Expose
Headers []string - In responses to preflight requests, lists names of headers that clients can access. By default, clients can access the following simple response headers:
Cache-Control
,Content-Language
,Content-Type
,Expires
,Last-Modified
, andPragma
. You can add other header names to make them accessible to clients. - Headers []string
- Defines the supported request headers.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Methods []string
- Specifies any combination of the following methods:
DELETE
,GET
,PATCH
,POST
, andPUT
that are allowed when accessing the resource from an external domain. - Origins []string
- Defines the origin hostnames to accept requests from. The hostnames that you enter need to start with
http
orhttps
. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications. - Preflight
Max stringAge - Defines the number of seconds that the browser should cache the response to a preflight request.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Credentials Boolean - Accepts requests made using credentials, like cookies or TLS client certificates.
- allow
Headers String - In responses to preflight requests, defines which headers to allow when making the actual request.
- allow
Origins String - In responses to preflight requests, sets which origin hostnames to accept requests from.
- enabled Boolean
- Enables CORS feature.
- expose
Headers List<String> - In responses to preflight requests, lists names of headers that clients can access. By default, clients can access the following simple response headers:
Cache-Control
,Content-Language
,Content-Type
,Expires
,Last-Modified
, andPragma
. You can add other header names to make them accessible to clients. - headers List<String>
- Defines the supported request headers.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- methods List<String>
- Specifies any combination of the following methods:
DELETE
,GET
,PATCH
,POST
, andPUT
that are allowed when accessing the resource from an external domain. - origins List<String>
- Defines the origin hostnames to accept requests from. The hostnames that you enter need to start with
http
orhttps
. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications. - preflight
Max StringAge - Defines the number of seconds that the browser should cache the response to a preflight request.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Credentials boolean - Accepts requests made using credentials, like cookies or TLS client certificates.
- allow
Headers string - In responses to preflight requests, defines which headers to allow when making the actual request.
- allow
Origins string - In responses to preflight requests, sets which origin hostnames to accept requests from.
- enabled boolean
- Enables CORS feature.
- expose
Headers string[] - In responses to preflight requests, lists names of headers that clients can access. By default, clients can access the following simple response headers:
Cache-Control
,Content-Language
,Content-Type
,Expires
,Last-Modified
, andPragma
. You can add other header names to make them accessible to clients. - headers string[]
- Defines the supported request headers.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- methods string[]
- Specifies any combination of the following methods:
DELETE
,GET
,PATCH
,POST
, andPUT
that are allowed when accessing the resource from an external domain. - origins string[]
- Defines the origin hostnames to accept requests from. The hostnames that you enter need to start with
http
orhttps
. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications. - preflight
Max stringAge - Defines the number of seconds that the browser should cache the response to a preflight request.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow_
credentials bool - Accepts requests made using credentials, like cookies or TLS client certificates.
- allow_
headers str - In responses to preflight requests, defines which headers to allow when making the actual request.
- allow_
origins str - In responses to preflight requests, sets which origin hostnames to accept requests from.
- enabled bool
- Enables CORS feature.
- expose_
headers Sequence[str] - In responses to preflight requests, lists names of headers that clients can access. By default, clients can access the following simple response headers:
Cache-Control
,Content-Language
,Content-Type
,Expires
,Last-Modified
, andPragma
. You can add other header names to make them accessible to clients. - headers Sequence[str]
- Defines the supported request headers.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- methods Sequence[str]
- Specifies any combination of the following methods:
DELETE
,GET
,PATCH
,POST
, andPUT
that are allowed when accessing the resource from an external domain. - origins Sequence[str]
- Defines the origin hostnames to accept requests from. The hostnames that you enter need to start with
http
orhttps
. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications. - preflight_
max_ strage - Defines the number of seconds that the browser should cache the response to a preflight request.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Credentials Boolean - Accepts requests made using credentials, like cookies or TLS client certificates.
- allow
Headers String - In responses to preflight requests, defines which headers to allow when making the actual request.
- allow
Origins String - In responses to preflight requests, sets which origin hostnames to accept requests from.
- enabled Boolean
- Enables CORS feature.
- expose
Headers List<String> - In responses to preflight requests, lists names of headers that clients can access. By default, clients can access the following simple response headers:
Cache-Control
,Content-Language
,Content-Type
,Expires
,Last-Modified
, andPragma
. You can add other header names to make them accessible to clients. - headers List<String>
- Defines the supported request headers.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- methods List<String>
- Specifies any combination of the following methods:
DELETE
,GET
,PATCH
,POST
, andPUT
that are allowed when accessing the resource from an external domain. - origins List<String>
- Defines the origin hostnames to accept requests from. The hostnames that you enter need to start with
http
orhttps
. For detailed hostname syntax requirements, refer to RFC-952 and RFC-1123 specifications. - preflight
Max StringAge - Defines the number of seconds that the browser should cache the response to a preflight request.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorCpCode
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Value
Get
Property Rules Builder Rules V20230105Behavior Cp Code Value - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Value
Get
Property Rules Builder Rules V20230105Behavior Cp Code Value - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value
Get
Property Rules Builder Rules V20230105Behavior Cp Code Value - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value
Get
Property Rules Builder Rules V20230105Behavior Cp Code Value - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value
Get
Property Rules Builder Rules V20230105Behavior Cp Code Value - Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value Property Map
- Specifies the CP code as an object. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data.
GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValue
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Cp Code Value Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Cp Code Value Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Cp Code Value Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Cp Code Value Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Cp Code Value Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorCpCodeValueCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorCustomBehavior
- Behavior
Id string - The unique identifier for the predefined custom behavior you want to insert into the current rule.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Behavior
Id string - The unique identifier for the predefined custom behavior you want to insert into the current rule.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior
Id String - The unique identifier for the predefined custom behavior you want to insert into the current rule.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior
Id string - The unique identifier for the predefined custom behavior you want to insert into the current rule.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior_
id str - The unique identifier for the predefined custom behavior you want to insert into the current rule.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior
Id String - The unique identifier for the predefined custom behavior you want to insert into the current rule.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDatastream
- Beacon
Stream stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Collect
Midgress boolTraffic - If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
- Datastream
Ids 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 bool
- Enables DataStream reporting.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Log
Enabled bool - Enables log collection for the property by associating it with DataStream configurations.
- Log
Stream intName - Specifies the unique IDs of streams configured for the property. For properties created with the previous version of the rule format, this option contains a string instead of an array of strings. You can use the
List streams
operation to get stream IDs. - Log
Stream stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Sampling
Percentage int - Specifies the percentage of log data you want to collect for this property.
- Stream
Type string - Specify the DataStream type.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Beacon
Stream stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Collect
Midgress boolTraffic - If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
- Datastream
Ids 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 bool
- Enables DataStream reporting.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Log
Enabled bool - Enables log collection for the property by associating it with DataStream configurations.
- Log
Stream intName - Specifies the unique IDs of streams configured for the property. For properties created with the previous version of the rule format, this option contains a string instead of an array of strings. You can use the
List streams
operation to get stream IDs. - Log
Stream stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Sampling
Percentage int - Specifies the percentage of log data you want to collect for this property.
- Stream
Type string - Specify the DataStream type.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- beacon
Stream StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- collect
Midgress BooleanTraffic - If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
- datastream
Ids 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 DataStream reporting.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- log
Enabled Boolean - Enables log collection for the property by associating it with DataStream configurations.
- log
Stream IntegerName - Specifies the unique IDs of streams configured for the property. For properties created with the previous version of the rule format, this option contains a string instead of an array of strings. You can use the
List streams
operation to get stream IDs. - log
Stream StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- sampling
Percentage Integer - Specifies the percentage of log data you want to collect for this property.
- stream
Type String - Specify the DataStream type.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- beacon
Stream stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- collect
Midgress booleanTraffic - If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
- datastream
Ids 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 DataStream reporting.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- log
Enabled boolean - Enables log collection for the property by associating it with DataStream configurations.
- log
Stream numberName - Specifies the unique IDs of streams configured for the property. For properties created with the previous version of the rule format, this option contains a string instead of an array of strings. You can use the
List streams
operation to get stream IDs. - log
Stream stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- sampling
Percentage number - Specifies the percentage of log data you want to collect for this property.
- stream
Type string - Specify the DataStream type.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- beacon_
stream_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- collect_
midgress_ booltraffic - If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
- datastream_
ids str - 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 bool
- Enables DataStream reporting.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- log_
enabled bool - Enables log collection for the property by associating it with DataStream configurations.
- log_
stream_ intname - Specifies the unique IDs of streams configured for the property. For properties created with the previous version of the rule format, this option contains a string instead of an array of strings. You can use the
List streams
operation to get stream IDs. - log_
stream_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- sampling_
percentage int - Specifies the percentage of log data you want to collect for this property.
- stream_
type str - Specify the DataStream type.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- beacon
Stream StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- collect
Midgress BooleanTraffic - If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.
- datastream
Ids 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 DataStream reporting.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- log
Enabled Boolean - Enables log collection for the property by associating it with DataStream configurations.
- log
Stream NumberName - Specifies the unique IDs of streams configured for the property. For properties created with the previous version of the rule format, this option contains a string instead of an array of strings. You can use the
List streams
operation to get stream IDs. - log
Stream StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- sampling
Percentage Number - Specifies the percentage of log data you want to collect for this property.
- stream
Type String - Specify the DataStream type.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDcp
- Anonymous bool
- When enabled, you don't need to pass the JWT token with the mqtt request, and JWT validation is skipped.
- Enabled bool
- Enables IoT Edge Connect.
- Gwenabled bool
- When enabled, you can publish and receive messages over a secured HTTP connection on port 443.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Namespace
Id 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 theIoT Edge Connect API
to configure access control lists for your namespace configuration. - Template
Uuid string - This option is for internal usage only.
- Tlsenabled bool
- When enabled, you can publish and receive messages over a secured MQTT connection on port 8883.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Wsenabled bool
- When enabled, you can publish and receive messages through a secured MQTT connection over WebSockets on port 443.
- Anonymous bool
- When enabled, you don't need to pass the JWT token with the mqtt request, and JWT validation is skipped.
- Enabled bool
- Enables IoT Edge Connect.
- Gwenabled bool
- When enabled, you can publish and receive messages over a secured HTTP connection on port 443.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Namespace
Id 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 theIoT Edge Connect API
to configure access control lists for your namespace configuration. - Template
Uuid string - This option is for internal usage only.
- Tlsenabled bool
- When enabled, you can publish and receive messages over a secured MQTT connection on port 8883.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Wsenabled bool
- When enabled, you can publish and receive messages through a secured MQTT connection over WebSockets on port 443.
- anonymous Boolean
- When enabled, you don't need to pass the JWT token with the mqtt request, and JWT validation is skipped.
- enabled Boolean
- Enables IoT Edge Connect.
- gwenabled Boolean
- When enabled, you can publish and receive messages over a secured HTTP connection on port 443.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- namespace
Id 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 theIoT Edge Connect API
to configure access control lists for your namespace configuration. - template
Uuid String - This option is for internal usage only.
- tlsenabled Boolean
- When enabled, you can publish and receive messages over a secured MQTT connection on port 8883.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- wsenabled Boolean
- When enabled, you can publish and receive messages through a secured MQTT connection over WebSockets on port 443.
- anonymous boolean
- When enabled, you don't need to pass the JWT token with the mqtt request, and JWT validation is skipped.
- enabled boolean
- Enables IoT Edge Connect.
- gwenabled boolean
- When enabled, you can publish and receive messages over a secured HTTP connection on port 443.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- namespace
Id 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 theIoT Edge Connect API
to configure access control lists for your namespace configuration. - template
Uuid string - This option is for internal usage only.
- tlsenabled boolean
- When enabled, you can publish and receive messages over a secured MQTT connection on port 8883.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- wsenabled boolean
- When enabled, you can publish and receive messages through a secured MQTT connection over WebSockets on port 443.
- anonymous bool
- When enabled, you don't need to pass the JWT token with the mqtt request, and JWT validation is skipped.
- enabled bool
- Enables IoT Edge Connect.
- gwenabled bool
- When enabled, you can publish and receive messages over a secured HTTP connection on port 443.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- namespace_
id str - 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 theIoT Edge Connect API
to configure access control lists for your namespace configuration. - template_
uuid str - This option is for internal usage only.
- tlsenabled bool
- When enabled, you can publish and receive messages over a secured MQTT connection on port 8883.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- wsenabled bool
- When enabled, you can publish and receive messages through a secured MQTT connection over WebSockets on port 443.
- anonymous Boolean
- When enabled, you don't need to pass the JWT token with the mqtt request, and JWT validation is skipped.
- enabled Boolean
- Enables IoT Edge Connect.
- gwenabled Boolean
- When enabled, you can publish and receive messages over a secured HTTP connection on port 443.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- namespace
Id 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 theIoT Edge Connect API
to configure access control lists for your namespace configuration. - template
Uuid String - This option is for internal usage only.
- tlsenabled Boolean
- When enabled, you can publish and receive messages over a secured MQTT connection on port 8883.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- wsenabled Boolean
- When enabled, you can publish and receive messages through a secured MQTT connection over WebSockets on port 443.
GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthHmacTransformation
- Hash
Conversion stringAlgorithm - Specifies the hash algorithm.
- Hash
Conversion stringKey - Specifies the key to generate the hash, ideally a long random string to ensure adequate security.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Hash
Conversion stringAlgorithm - Specifies the hash algorithm.
- Hash
Conversion stringKey - Specifies the key to generate the hash, ideally a long random string to ensure adequate security.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- hash
Conversion StringAlgorithm - Specifies the hash algorithm.
- hash
Conversion StringKey - Specifies the key to generate the hash, ideally a long random string to ensure adequate security.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- hash
Conversion stringAlgorithm - Specifies the hash algorithm.
- hash
Conversion stringKey - Specifies the key to generate the hash, ideally a long random string to ensure adequate security.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- hash_
conversion_ stralgorithm - Specifies the hash algorithm.
- hash_
conversion_ strkey - Specifies the key to generate the hash, ideally a long random string to ensure adequate security.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- hash
Conversion StringAlgorithm - Specifies the hash algorithm.
- hash
Conversion StringKey - Specifies the key to generate the hash, ideally a long random string to ensure adequate security.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthRegexTransformation
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Regex
Pattern 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. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Regex
Pattern 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. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- regex
Pattern 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. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- regex
Pattern 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. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- regex_
pattern str - 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. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- regex
Pattern 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. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthSubstringTransformation
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Substring
End 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. - Substring
Start 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.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Substring
End 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. - Substring
Start 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.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- substring
End 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. - substring
Start 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.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- substring
End 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. - substring
Start 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.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- substring_
end str - 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. - substring_
start str - 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.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- substring
End 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. - substring
Start 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.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDcpAuthVariableExtractor
- Certificate
Field string - Specifies the field in the client certificate to extract the variable from.
- Dcp
Mutual stringAuth Processing Variable Id - Where to store the value.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Certificate
Field string - Specifies the field in the client certificate to extract the variable from.
- Dcp
Mutual stringAuth Processing Variable Id - Where to store the value.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- certificate
Field String - Specifies the field in the client certificate to extract the variable from.
- dcp
Mutual StringAuth Processing Variable Id - Where to store the value.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- certificate
Field string - Specifies the field in the client certificate to extract the variable from.
- dcp
Mutual stringAuth Processing Variable Id - Where to store the value.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- certificate_
field str - Specifies the field in the client certificate to extract the variable from.
- dcp_
mutual_ strauth_ processing_ variable_ id - Where to store the value.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- certificate
Field String - Specifies the field in the client certificate to extract the variable from.
- dcp
Mutual StringAuth Processing Variable Id - Where to store the value.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDcpDefaultAuthzGroups
- Group
Names List<string> - Specifies the set of authorization groups to assign to all connecting devices.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Group
Names []string - Specifies the set of authorization groups to assign to all connecting devices.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- group
Names List<String> - Specifies the set of authorization groups to assign to all connecting devices.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- group
Names string[] - Specifies the set of authorization groups to assign to all connecting devices.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- group_
names Sequence[str] - Specifies the set of authorization groups to assign to all connecting devices.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- group
Names List<String> - Specifies the set of authorization groups to assign to all connecting devices.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDcpDevRelations
- Custom
Values bool - Allows you to specify custom JWT server connection values.
- Enabled bool
- Enables the default JWT server and sets the authentication endpoint to a default path.
- Hostname string
- Specifies the JWT server's hostname.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Path string
- Specifies the path to your JWT server's authentication endpoint. This lets you generate JWTs to sign your requests.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Custom
Values bool - Allows you to specify custom JWT server connection values.
- Enabled bool
- Enables the default JWT server and sets the authentication endpoint to a default path.
- Hostname string
- Specifies the JWT server's hostname.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Path string
- Specifies the path to your JWT server's authentication endpoint. This lets you generate JWTs to sign your requests.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Values Boolean - Allows you to specify custom JWT server connection values.
- enabled Boolean
- Enables the default JWT server and sets the authentication endpoint to a default path.
- hostname String
- Specifies the JWT server's hostname.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- path String
- Specifies the path to your JWT server's authentication endpoint. This lets you generate JWTs to sign your requests.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Values boolean - Allows you to specify custom JWT server connection values.
- enabled boolean
- Enables the default JWT server and sets the authentication endpoint to a default path.
- hostname string
- Specifies the JWT server's hostname.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- path string
- Specifies the path to your JWT server's authentication endpoint. This lets you generate JWTs to sign your requests.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom_
values bool - Allows you to specify custom JWT server connection values.
- enabled bool
- Enables the default JWT server and sets the authentication endpoint to a default path.
- hostname str
- Specifies the JWT server's hostname.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- path str
- Specifies the path to your JWT server's authentication endpoint. This lets you generate JWTs to sign your requests.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Values Boolean - Allows you to specify custom JWT server connection values.
- enabled Boolean
- Enables the default JWT server and sets the authentication endpoint to a default path.
- hostname String
- Specifies the JWT server's hostname.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- path String
- Specifies the path to your JWT server's authentication endpoint. This lets you generate JWTs to sign your requests.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDcpRealTimeAuth
- Extract
Hostname bool - Extracts a hostname from JWT.
- Extract
Jurisdiction bool - Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
- Extract
Namespace bool - Extracts a namespace from JSON web tokens (JWT).
- Hostname
Claim string - Specifies the claim in JWT to extract the hostname from.
- Jurisdiction
Claim string - Specifies the claim in JWT to extract the jurisdiction from.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Namespace
Claim string - Specifies the claim in JWT to extract the namespace from.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Extract
Hostname bool - Extracts a hostname from JWT.
- Extract
Jurisdiction bool - Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
- Extract
Namespace bool - Extracts a namespace from JSON web tokens (JWT).
- Hostname
Claim string - Specifies the claim in JWT to extract the hostname from.
- Jurisdiction
Claim string - Specifies the claim in JWT to extract the jurisdiction from.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Namespace
Claim string - Specifies the claim in JWT to extract the namespace from.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- extract
Hostname Boolean - Extracts a hostname from JWT.
- extract
Jurisdiction Boolean - Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
- extract
Namespace Boolean - Extracts a namespace from JSON web tokens (JWT).
- hostname
Claim String - Specifies the claim in JWT to extract the hostname from.
- jurisdiction
Claim String - Specifies the claim in JWT to extract the jurisdiction from.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- namespace
Claim String - Specifies the claim in JWT to extract the namespace from.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- extract
Hostname boolean - Extracts a hostname from JWT.
- extract
Jurisdiction boolean - Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
- extract
Namespace boolean - Extracts a namespace from JSON web tokens (JWT).
- hostname
Claim string - Specifies the claim in JWT to extract the hostname from.
- jurisdiction
Claim string - Specifies the claim in JWT to extract the jurisdiction from.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- namespace
Claim string - Specifies the claim in JWT to extract the namespace from.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- extract_
hostname bool - Extracts a hostname from JWT.
- extract_
jurisdiction bool - Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
- extract_
namespace bool - Extracts a namespace from JSON web tokens (JWT).
- hostname_
claim str - Specifies the claim in JWT to extract the hostname from.
- jurisdiction_
claim str - Specifies the claim in JWT to extract the jurisdiction from.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- namespace_
claim str - Specifies the claim in JWT to extract the namespace from.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- extract
Hostname Boolean - Extracts a hostname from JWT.
- extract
Jurisdiction Boolean - Extracts a jurisdiction that defines a geographically distributed set of servers from JWT.
- extract
Namespace Boolean - Extracts a namespace from JSON web tokens (JWT).
- hostname
Claim String - Specifies the claim in JWT to extract the hostname from.
- jurisdiction
Claim String - Specifies the claim in JWT to extract the jurisdiction from.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- namespace
Claim String - Specifies the claim in JWT to extract the namespace from.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDeliveryReceipt
- Enabled string
- Enables the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled string
- Enables the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- Enables the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled string
- Enables the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled str
- Enables the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- Enables the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDenyAccess
- Enabled bool
- Denies access when enabled.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Reason string
- Text message that keys why access is denied. Any subsequent
denyAccess
behaviors within the rule tree may refer to the samereason
key to override the current behavior. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Denies access when enabled.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Reason string
- Text message that keys why access is denied. Any subsequent
denyAccess
behaviors within the rule tree may refer to the samereason
key to override the current behavior. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Denies access when enabled.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- reason String
- Text message that keys why access is denied. Any subsequent
denyAccess
behaviors within the rule tree may refer to the samereason
key to override the current behavior. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Denies access when enabled.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- reason string
- Text message that keys why access is denied. Any subsequent
denyAccess
behaviors within the rule tree may refer to the samereason
key to override the current behavior. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Denies access when enabled.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- reason str
- Text message that keys why access is denied. Any subsequent
denyAccess
behaviors within the rule tree may refer to the samereason
key to override the current behavior. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Denies access when enabled.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- reason String
- Text message that keys why access is denied. Any subsequent
denyAccess
behaviors within the rule tree may refer to the samereason
key to override the current behavior. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDenyDirectFailoverAccess
- Enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicCacheId
- Elements List<string>
- Specifies a set of information about the device with which to generate a separate cache key.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Elements []string
- Specifies a set of information about the device with which to generate a separate cache key.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- elements List<String>
- Specifies a set of information about the device with which to generate a separate cache key.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- elements string[]
- Specifies a set of information about the device with which to generate a separate cache key.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- elements Sequence[str]
- Specifies a set of information about the device with which to generate a separate cache key.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- elements List<String>
- Specifies a set of information about the device with which to generate a separate cache key.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDeviceCharacteristicHeader
- Elements List<string>
- Specifies the set of information about the requesting device to send to the origin server.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Elements []string
- Specifies the set of information about the requesting device to send to the origin server.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- elements List<String>
- Specifies the set of information about the requesting device to send to the origin server.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- elements string[]
- Specifies the set of information about the requesting device to send to the origin server.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- elements Sequence[str]
- Specifies the set of information about the requesting device to send to the origin server.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- elements List<String>
- Specifies the set of information about the requesting device to send to the origin server.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDnsAsyncRefresh
- Enabled bool
- Allows edge servers to refresh an expired DNS record after serving content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Timeout string
- Set the maximum allowed time an expired DNS record may be active.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Allows edge servers to refresh an expired DNS record after serving content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Timeout string
- Set the maximum allowed time an expired DNS record may be active.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows edge servers to refresh an expired DNS record after serving content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- timeout String
- Set the maximum allowed time an expired DNS record may be active.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Allows edge servers to refresh an expired DNS record after serving content.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- timeout string
- Set the maximum allowed time an expired DNS record may be active.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Allows edge servers to refresh an expired DNS record after serving content.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- timeout str
- Set the maximum allowed time an expired DNS record may be active.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Allows edge servers to refresh an expired DNS record after serving content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- timeout String
- Set the maximum allowed time an expired DNS record may be active.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDnsPrefresh
- Delay string
- Specifies the amount of time following a DNS record's expiration to asynchronously prefresh it.
- Enabled bool
- Allows edge servers to refresh DNS records before they expire.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Timeout string
- Specifies the amount of time to prefresh a DNS entry if there have been no requests to the domain name.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Delay string
- Specifies the amount of time following a DNS record's expiration to asynchronously prefresh it.
- Enabled bool
- Allows edge servers to refresh DNS records before they expire.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Timeout string
- Specifies the amount of time to prefresh a DNS entry if there have been no requests to the domain name.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- delay String
- Specifies the amount of time following a DNS record's expiration to asynchronously prefresh it.
- enabled Boolean
- Allows edge servers to refresh DNS records before they expire.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- timeout String
- Specifies the amount of time to prefresh a DNS entry if there have been no requests to the domain name.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- delay string
- Specifies the amount of time following a DNS record's expiration to asynchronously prefresh it.
- enabled boolean
- Allows edge servers to refresh DNS records before they expire.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- timeout string
- Specifies the amount of time to prefresh a DNS entry if there have been no requests to the domain name.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- delay str
- Specifies the amount of time following a DNS record's expiration to asynchronously prefresh it.
- enabled bool
- Allows edge servers to refresh DNS records before they expire.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- timeout str
- Specifies the amount of time to prefresh a DNS entry if there have been no requests to the domain name.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- delay String
- Specifies the amount of time following a DNS record's expiration to asynchronously prefresh it.
- enabled Boolean
- Allows edge servers to refresh DNS records before they expire.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- timeout String
- Specifies the amount of time to prefresh a DNS entry if there have been no requests to the domain name.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDowngradeProtocol
- Enabled bool
- Enables the protocol downgrading behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the protocol downgrading behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the protocol downgrading behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the protocol downgrading behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the protocol downgrading behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the protocol downgrading behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDownloadCompleteMarker
- Enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDownloadNotification
- Enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDownstreamCache
- Allow
Behavior string - Specify how the edge server calculates the downstream cache by setting the value of the
Expires
header. - Behavior string
- Specify the caching instructions the edge server sends to the end user's client.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Send
Headers string - Specifies the HTTP headers to include in the response to the client.
- Send
Private bool - Adds a
Cache-Control: private
header to prevent objects from being cached in a shared caching proxy. - Template
Uuid string - This option is for internal usage only.
- Ttl string
- Sets the duration of the cache. Setting the value to
0
equates to ano-cache
header that forces revalidation. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Allow
Behavior string - Specify how the edge server calculates the downstream cache by setting the value of the
Expires
header. - Behavior string
- Specify the caching instructions the edge server sends to the end user's client.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Send
Headers string - Specifies the HTTP headers to include in the response to the client.
- Send
Private bool - Adds a
Cache-Control: private
header to prevent objects from being cached in a shared caching proxy. - Template
Uuid string - This option is for internal usage only.
- Ttl string
- Sets the duration of the cache. Setting the value to
0
equates to ano-cache
header that forces revalidation. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Behavior String - Specify how the edge server calculates the downstream cache by setting the value of the
Expires
header. - behavior String
- Specify the caching instructions the edge server sends to the end user's client.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- send
Headers String - Specifies the HTTP headers to include in the response to the client.
- send
Private Boolean - Adds a
Cache-Control: private
header to prevent objects from being cached in a shared caching proxy. - template
Uuid String - This option is for internal usage only.
- ttl String
- Sets the duration of the cache. Setting the value to
0
equates to ano-cache
header that forces revalidation. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Behavior string - Specify how the edge server calculates the downstream cache by setting the value of the
Expires
header. - behavior string
- Specify the caching instructions the edge server sends to the end user's client.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- send
Headers string - Specifies the HTTP headers to include in the response to the client.
- send
Private boolean - Adds a
Cache-Control: private
header to prevent objects from being cached in a shared caching proxy. - template
Uuid string - This option is for internal usage only.
- ttl string
- Sets the duration of the cache. Setting the value to
0
equates to ano-cache
header that forces revalidation. - uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow_
behavior str - Specify how the edge server calculates the downstream cache by setting the value of the
Expires
header. - behavior str
- Specify the caching instructions the edge server sends to the end user's client.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- send_
headers str - Specifies the HTTP headers to include in the response to the client.
- send_
private bool - Adds a
Cache-Control: private
header to prevent objects from being cached in a shared caching proxy. - template_
uuid str - This option is for internal usage only.
- ttl str
- Sets the duration of the cache. Setting the value to
0
equates to ano-cache
header that forces revalidation. - uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- allow
Behavior String - Specify how the edge server calculates the downstream cache by setting the value of the
Expires
header. - behavior String
- Specify the caching instructions the edge server sends to the end user's client.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- send
Headers String - Specifies the HTTP headers to include in the response to the client.
- send
Private Boolean - Adds a
Cache-Control: private
header to prevent objects from being cached in a shared caching proxy. - template
Uuid String - This option is for internal usage only.
- ttl String
- Sets the duration of the cache. Setting the value to
0
equates to ano-cache
header that forces revalidation. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimization
- Enabled bool
- Enables the quick retry feature.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the quick retry feature.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the quick retry feature.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the quick retry feature.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the quick retry feature.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the quick retry feature.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDynamicThroughtputOptimizationOverride
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Throughput string
- Specifies the default target forward throughput in Mbps, ranging from 2 to 50 Mbps. If this time is exceeded during a connection attempt, quick retry is enabled and a different forward connection path is used.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Throughput string
- Specifies the default target forward throughput in Mbps, ranging from 2 to 50 Mbps. If this time is exceeded during a connection attempt, quick retry is enabled and a different forward connection path is used.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- throughput String
- Specifies the default target forward throughput in Mbps, ranging from 2 to 50 Mbps. If this time is exceeded during a connection attempt, quick retry is enabled and a different forward connection path is used.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- throughput string
- Specifies the default target forward throughput in Mbps, ranging from 2 to 50 Mbps. If this time is exceeded during a connection attempt, quick retry is enabled and a different forward connection path is used.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- throughput str
- Specifies the default target forward throughput in Mbps, ranging from 2 to 50 Mbps. If this time is exceeded during a connection attempt, quick retry is enabled and a different forward connection path is used.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- throughput String
- Specifies the default target forward throughput in Mbps, ranging from 2 to 50 Mbps. If this time is exceeded during a connection attempt, quick retry is enabled and a different forward connection path is used.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorDynamicWebContent
- Image
Compression bool - Enables image compression for subcustomer content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Prefetch bool
- Allows subcustomer content to prefetch over HTTP/2.
- Real
User boolMonitoring - Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the
realUserMonitoring
behavior for more information. - Sure
Route bool - Optimizes how subcustomer traffic routes from origin to edge servers. See the
sureRoute
behavior for more information. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Image
Compression bool - Enables image compression for subcustomer content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Prefetch bool
- Allows subcustomer content to prefetch over HTTP/2.
- Real
User boolMonitoring - Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the
realUserMonitoring
behavior for more information. - Sure
Route bool - Optimizes how subcustomer traffic routes from origin to edge servers. See the
sureRoute
behavior for more information. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- image
Compression Boolean - Enables image compression for subcustomer content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- prefetch Boolean
- Allows subcustomer content to prefetch over HTTP/2.
- real
User BooleanMonitoring - Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the
realUserMonitoring
behavior for more information. - sure
Route Boolean - Optimizes how subcustomer traffic routes from origin to edge servers. See the
sureRoute
behavior for more information. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- image
Compression boolean - Enables image compression for subcustomer content.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- prefetch boolean
- Allows subcustomer content to prefetch over HTTP/2.
- real
User booleanMonitoring - Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the
realUserMonitoring
behavior for more information. - sure
Route boolean - Optimizes how subcustomer traffic routes from origin to edge servers. See the
sureRoute
behavior for more information. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- image_
compression bool - Enables image compression for subcustomer content.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- prefetch bool
- Allows subcustomer content to prefetch over HTTP/2.
- real_
user_ boolmonitoring - Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the
realUserMonitoring
behavior for more information. - sure_
route bool - Optimizes how subcustomer traffic routes from origin to edge servers. See the
sureRoute
behavior for more information. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- image
Compression Boolean - Enables image compression for subcustomer content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- prefetch Boolean
- Allows subcustomer content to prefetch over HTTP/2.
- real
User BooleanMonitoring - Allows Real User Monitoring (RUM) to collect performance data for subcustomer content. See the
realUserMonitoring
behavior for more information. - sure
Route Boolean - Optimizes how subcustomer traffic routes from origin to edge servers. See the
sureRoute
behavior for more information. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEcmsBulkUpload
- Enabled bool
- Enables sending a compressed archive file with objects. Sends the archive file to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables sending a compressed archive file with objects. Sends the archive file to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables sending a compressed archive file with objects. Sends the archive file to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables sending a compressed archive file with objects. Sends the archive file to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables sending a compressed archive file with objects. Sends the archive file to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables sending a compressed archive file with objects. Sends the archive file to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDatabase
- Database string
- Specifies a default database for this property. If you don't configure a default data set in the
ecmsDataset
behavior, requests to objects in this database follow the pattern:<hostname>/datastore/<data_set_name>/<object_key>
. - Extract
Location string - Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database is used.
- Header
Name string - Specifies the request header that passed the database name. By default, it points to
X-KV-Database
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Query
Parameter stringName - Specifies the query string parameter that passed the database name. By default, it points to
database
. - Regex
Pattern string - Specifies the regular expression that matches the database name in the URL.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Database string
- Specifies a default database for this property. If you don't configure a default data set in the
ecmsDataset
behavior, requests to objects in this database follow the pattern:<hostname>/datastore/<data_set_name>/<object_key>
. - Extract
Location string - Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database is used.
- Header
Name string - Specifies the request header that passed the database name. By default, it points to
X-KV-Database
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Query
Parameter stringName - Specifies the query string parameter that passed the database name. By default, it points to
database
. - Regex
Pattern string - Specifies the regular expression that matches the database name in the URL.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- database String
- Specifies a default database for this property. If you don't configure a default data set in the
ecmsDataset
behavior, requests to objects in this database follow the pattern:<hostname>/datastore/<data_set_name>/<object_key>
. - extract
Location String - Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database is used.
- header
Name String - Specifies the request header that passed the database name. By default, it points to
X-KV-Database
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- query
Parameter StringName - Specifies the query string parameter that passed the database name. By default, it points to
database
. - regex
Pattern String - Specifies the regular expression that matches the database name in the URL.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- database string
- Specifies a default database for this property. If you don't configure a default data set in the
ecmsDataset
behavior, requests to objects in this database follow the pattern:<hostname>/datastore/<data_set_name>/<object_key>
. - extract
Location string - Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database is used.
- header
Name string - Specifies the request header that passed the database name. By default, it points to
X-KV-Database
. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- query
Parameter stringName - Specifies the query string parameter that passed the database name. By default, it points to
database
. - regex
Pattern string - Specifies the regular expression that matches the database name in the URL.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- database str
- Specifies a default database for this property. If you don't configure a default data set in the
ecmsDataset
behavior, requests to objects in this database follow the pattern:<hostname>/datastore/<data_set_name>/<object_key>
. - extract_
location str - Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database is used.
- header_
name str - Specifies the request header that passed the database name. By default, it points to
X-KV-Database
. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- query_
parameter_ strname - Specifies the query string parameter that passed the database name. By default, it points to
database
. - regex_
pattern str - Specifies the regular expression that matches the database name in the URL.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- database String
- Specifies a default database for this property. If you don't configure a default data set in the
ecmsDataset
behavior, requests to objects in this database follow the pattern:<hostname>/datastore/<data_set_name>/<object_key>
. - extract
Location String - Specifies where to pass a database name in requests. If the specified location doesn't include the database name or the name doesn't match the regular expression, the default database is used.
- header
Name String - Specifies the request header that passed the database name. By default, it points to
X-KV-Database
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- query
Parameter StringName - Specifies the query string parameter that passed the database name. By default, it points to
database
. - regex
Pattern String - Specifies the regular expression that matches the database name in the URL.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEcmsDataset
- Dataset string
- Specifies a default data set for this property. If you don't configure a default database in the
ecmsDatabase
behavior, requests to objects in this data set follow the pattern:<hostname>/datastore/<database_name>/<object_key>
. - Extract
Location string - Specifies where to pass a data set name in requests. If the specified location doesn't include the data set name or the name doesn't match the regular expression pattern, the default data set is used.
- Header
Name string - Specifies the request header that passed the data set name. By default, it points to
X-KV-Dataset
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Query
Parameter stringName - Specifies the query string parameter that passed the data set name. By default, it points to
dataset
. - Regex
Pattern string - Specifies the regular expression that matches the data set name in the URL.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Dataset string
- Specifies a default data set for this property. If you don't configure a default database in the
ecmsDatabase
behavior, requests to objects in this data set follow the pattern:<hostname>/datastore/<database_name>/<object_key>
. - Extract
Location string - Specifies where to pass a data set name in requests. If the specified location doesn't include the data set name or the name doesn't match the regular expression pattern, the default data set is used.
- Header
Name string - Specifies the request header that passed the data set name. By default, it points to
X-KV-Dataset
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Query
Parameter stringName - Specifies the query string parameter that passed the data set name. By default, it points to
dataset
. - Regex
Pattern string - Specifies the regular expression that matches the data set name in the URL.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- dataset String
- Specifies a default data set for this property. If you don't configure a default database in the
ecmsDatabase
behavior, requests to objects in this data set follow the pattern:<hostname>/datastore/<database_name>/<object_key>
. - extract
Location String - Specifies where to pass a data set name in requests. If the specified location doesn't include the data set name or the name doesn't match the regular expression pattern, the default data set is used.
- header
Name String - Specifies the request header that passed the data set name. By default, it points to
X-KV-Dataset
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- query
Parameter StringName - Specifies the query string parameter that passed the data set name. By default, it points to
dataset
. - regex
Pattern String - Specifies the regular expression that matches the data set name in the URL.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- dataset string
- Specifies a default data set for this property. If you don't configure a default database in the
ecmsDatabase
behavior, requests to objects in this data set follow the pattern:<hostname>/datastore/<database_name>/<object_key>
. - extract
Location string - Specifies where to pass a data set name in requests. If the specified location doesn't include the data set name or the name doesn't match the regular expression pattern, the default data set is used.
- header
Name string - Specifies the request header that passed the data set name. By default, it points to
X-KV-Dataset
. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- query
Parameter stringName - Specifies the query string parameter that passed the data set name. By default, it points to
dataset
. - regex
Pattern string - Specifies the regular expression that matches the data set name in the URL.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- dataset str
- Specifies a default data set for this property. If you don't configure a default database in the
ecmsDatabase
behavior, requests to objects in this data set follow the pattern:<hostname>/datastore/<database_name>/<object_key>
. - extract_
location str - Specifies where to pass a data set name in requests. If the specified location doesn't include the data set name or the name doesn't match the regular expression pattern, the default data set is used.
- header_
name str - Specifies the request header that passed the data set name. By default, it points to
X-KV-Dataset
. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- query_
parameter_ strname - Specifies the query string parameter that passed the data set name. By default, it points to
dataset
. - regex_
pattern str - Specifies the regular expression that matches the data set name in the URL.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- dataset String
- Specifies a default data set for this property. If you don't configure a default database in the
ecmsDatabase
behavior, requests to objects in this data set follow the pattern:<hostname>/datastore/<database_name>/<object_key>
. - extract
Location String - Specifies where to pass a data set name in requests. If the specified location doesn't include the data set name or the name doesn't match the regular expression pattern, the default data set is used.
- header
Name String - Specifies the request header that passed the data set name. By default, it points to
X-KV-Dataset
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- query
Parameter StringName - Specifies the query string parameter that passed the data set name. By default, it points to
dataset
. - regex
Pattern String - Specifies the regular expression that matches the data set name in the URL.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEcmsObjectKey
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Regex string
- Enables sending a compressed archive file with objects to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Regex string
- Enables sending a compressed archive file with objects to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- regex String
- Enables sending a compressed archive file with objects to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- regex string
- Enables sending a compressed archive file with objects to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- regex str
- Enables sending a compressed archive file with objects to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- regex String
- Enables sending a compressed archive file with objects to the default path of the target data set:
<hostname>/bulk/<database_name>/<dataset_name>
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeConnect
- Aggregate
Lines string - Specifies the maximum number of lines to include in each log.
- Aggregate
Size string - Specifies the log's maximum size.
- Aggregate
Time string - Specifies how often logs are generated.
- Api
Connector string - Describes the API connector type.
- Api
Data List<string>Elements - Specifies the data set to log.
- Destination
Hostname string - Specifies the target hostname accepting push API requests.
- Destination
Path string - Specifies the push API's endpoint.
- Enabled bool
- Enables Cloud Monitor's log-publishing behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Override
Aggregate boolSettings - When enabled, overrides default log settings.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Aggregate
Lines string - Specifies the maximum number of lines to include in each log.
- Aggregate
Size string - Specifies the log's maximum size.
- Aggregate
Time string - Specifies how often logs are generated.
- Api
Connector string - Describes the API connector type.
- Api
Data []stringElements - Specifies the data set to log.
- Destination
Hostname string - Specifies the target hostname accepting push API requests.
- Destination
Path string - Specifies the push API's endpoint.
- Enabled bool
- Enables Cloud Monitor's log-publishing behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Override
Aggregate boolSettings - When enabled, overrides default log settings.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- aggregate
Lines String - Specifies the maximum number of lines to include in each log.
- aggregate
Size String - Specifies the log's maximum size.
- aggregate
Time String - Specifies how often logs are generated.
- api
Connector String - Describes the API connector type.
- api
Data List<String>Elements - Specifies the data set to log.
- destination
Hostname String - Specifies the target hostname accepting push API requests.
- destination
Path String - Specifies the push API's endpoint.
- enabled Boolean
- Enables Cloud Monitor's log-publishing behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override
Aggregate BooleanSettings - When enabled, overrides default log settings.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- aggregate
Lines string - Specifies the maximum number of lines to include in each log.
- aggregate
Size string - Specifies the log's maximum size.
- aggregate
Time string - Specifies how often logs are generated.
- api
Connector string - Describes the API connector type.
- api
Data string[]Elements - Specifies the data set to log.
- destination
Hostname string - Specifies the target hostname accepting push API requests.
- destination
Path string - Specifies the push API's endpoint.
- enabled boolean
- Enables Cloud Monitor's log-publishing behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override
Aggregate booleanSettings - When enabled, overrides default log settings.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- aggregate_
lines str - Specifies the maximum number of lines to include in each log.
- aggregate_
size str - Specifies the log's maximum size.
- aggregate_
time str - Specifies how often logs are generated.
- api_
connector str - Describes the API connector type.
- api_
data_ Sequence[str]elements - Specifies the data set to log.
- destination_
hostname str - Specifies the target hostname accepting push API requests.
- destination_
path str - Specifies the push API's endpoint.
- enabled bool
- Enables Cloud Monitor's log-publishing behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override_
aggregate_ boolsettings - When enabled, overrides default log settings.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- aggregate
Lines String - Specifies the maximum number of lines to include in each log.
- aggregate
Size String - Specifies the log's maximum size.
- aggregate
Time String - Specifies how often logs are generated.
- api
Connector String - Describes the API connector type.
- api
Data List<String>Elements - Specifies the data set to log.
- destination
Hostname String - Specifies the target hostname accepting push API requests.
- destination
Path String - Specifies the push API's endpoint.
- enabled Boolean
- Enables Cloud Monitor's log-publishing behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override
Aggregate BooleanSettings - When enabled, overrides default log settings.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingAdvanced
- Description string
- A description of what the
xml
block does. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Xml string
- A block of Akamai XML metadata.
- Description string
- A description of what the
xml
block does. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Xml string
- A block of Akamai XML metadata.
- description String
- A description of what the
xml
block does. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml String
- A block of Akamai XML metadata.
- description string
- A description of what the
xml
block does. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml string
- A block of Akamai XML metadata.
- description str
- A description of what the
xml
block does. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml str
- A block of Akamai XML metadata.
- description String
- A description of what the
xml
block does. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml String
- A block of Akamai XML metadata.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenter
- string
- If using session persistence, this specifies the value of the cookie named in the corresponding
edgeLoadBalancingOrigin
behavior'scookie_name
option. - Description string
- Provides a description for the ELB data center, for your own reference.
- Enable
Failover bool - Allows you to specify failover rules.
- Failover
Rules List<GetProperty Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center Failover Rule> - Provides up to four failover rules to apply in the specified order.
- Failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Hostname string
- Specifies the data center's hostname.
- Ip string
- Specifies this data center's IP address.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Origin
Id string - Corresponds to the
id
specified by theedgeLoadBalancingOrigin
behavior associated with this data center. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- string
- If using session persistence, this specifies the value of the cookie named in the corresponding
edgeLoadBalancingOrigin
behavior'scookie_name
option. - Description string
- Provides a description for the ELB data center, for your own reference.
- Enable
Failover bool - Allows you to specify failover rules.
- Failover
Rules []GetProperty Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center Failover Rule - Provides up to four failover rules to apply in the specified order.
- Failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Hostname string
- Specifies the data center's hostname.
- Ip string
- Specifies this data center's IP address.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Origin
Id string - Corresponds to the
id
specified by theedgeLoadBalancingOrigin
behavior associated with this data center. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- String
- If using session persistence, this specifies the value of the cookie named in the corresponding
edgeLoadBalancingOrigin
behavior'scookie_name
option. - description String
- Provides a description for the ELB data center, for your own reference.
- enable
Failover Boolean - Allows you to specify failover rules.
- failover
Rules List<GetProperty Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center Failover Rule> - Provides up to four failover rules to apply in the specified order.
- failover
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- hostname String
- Specifies the data center's hostname.
- ip String
- Specifies this data center's IP address.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origin
Id String - Corresponds to the
id
specified by theedgeLoadBalancingOrigin
behavior associated with this data center. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- string
- If using session persistence, this specifies the value of the cookie named in the corresponding
edgeLoadBalancingOrigin
behavior'scookie_name
option. - description string
- Provides a description for the ELB data center, for your own reference.
- enable
Failover boolean - Allows you to specify failover rules.
- failover
Rules GetProperty Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center Failover Rule[] - Provides up to four failover rules to apply in the specified order.
- failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- hostname string
- Specifies the data center's hostname.
- ip string
- Specifies this data center's IP address.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origin
Id string - Corresponds to the
id
specified by theedgeLoadBalancingOrigin
behavior associated with this data center. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- str
- If using session persistence, this specifies the value of the cookie named in the corresponding
edgeLoadBalancingOrigin
behavior'scookie_name
option. - description str
- Provides a description for the ELB data center, for your own reference.
- enable_
failover bool - Allows you to specify failover rules.
- failover_
rules Sequence[GetProperty Rules Builder Rules V20230105Behavior Edge Load Balancing Data Center Failover Rule] - Provides up to four failover rules to apply in the specified order.
- failover_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- hostname str
- Specifies the data center's hostname.
- ip str
- Specifies this data center's IP address.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origin_
id str - Corresponds to the
id
specified by theedgeLoadBalancingOrigin
behavior associated with this data center. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- String
- If using session persistence, this specifies the value of the cookie named in the corresponding
edgeLoadBalancingOrigin
behavior'scookie_name
option. - description String
- Provides a description for the ELB data center, for your own reference.
- enable
Failover Boolean - Allows you to specify failover rules.
- failover
Rules List<Property Map> - Provides up to four failover rules to apply in the specified order.
- failover
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- hostname String
- Specifies the data center's hostname.
- ip String
- Specifies this data center's IP address.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origin
Id String - Corresponds to the
id
specified by theedgeLoadBalancingOrigin
behavior associated with this data center. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingDataCenterFailoverRule
- Absolute
Path bool - When enabled, interprets the path specified by
context_root
as an absolute server path, for example to reference a site-down page. Otherwise when disabled, the path is appended to the request. - Context
Root string - 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. - Failover
Hostname string - The hostname of the data center to fail over to.
- Modify
Request bool - Allows you to modify the request's hostname or path.
- Override
Hostname bool - Overrides the request's hostname with the
failover_hostname
.
- Absolute
Path bool - When enabled, interprets the path specified by
context_root
as an absolute server path, for example to reference a site-down page. Otherwise when disabled, the path is appended to the request. - Context
Root string - 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. - Failover
Hostname string - The hostname of the data center to fail over to.
- Modify
Request bool - Allows you to modify the request's hostname or path.
- Override
Hostname bool - Overrides the request's hostname with the
failover_hostname
.
- absolute
Path Boolean - When enabled, interprets the path specified by
context_root
as an absolute server path, for example to reference a site-down page. Otherwise when disabled, the path is appended to the request. - context
Root String - 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. - failover
Hostname String - The hostname of the data center to fail over to.
- modify
Request Boolean - Allows you to modify the request's hostname or path.
- override
Hostname Boolean - Overrides the request's hostname with the
failover_hostname
.
- absolute
Path boolean - When enabled, interprets the path specified by
context_root
as an absolute server path, for example to reference a site-down page. Otherwise when disabled, the path is appended to the request. - context
Root string - 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. - failover
Hostname string - The hostname of the data center to fail over to.
- modify
Request boolean - Allows you to modify the request's hostname or path.
- override
Hostname boolean - Overrides the request's hostname with the
failover_hostname
.
- absolute_
path bool - When enabled, interprets the path specified by
context_root
as an absolute server path, for example to reference a site-down page. Otherwise when disabled, the path is appended to the request. - context_
root str - 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. - failover_
hostname str - The hostname of the data center to fail over to.
- modify_
request bool - Allows you to modify the request's hostname or path.
- override_
hostname bool - Overrides the request's hostname with the
failover_hostname
.
- absolute
Path Boolean - When enabled, interprets the path specified by
context_root
as an absolute server path, for example to reference a site-down page. Otherwise when disabled, the path is appended to the request. - context
Root String - 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. - failover
Hostname String - The hostname of the data center to fail over to.
- modify
Request Boolean - Allows you to modify the request's hostname or path.
- override
Hostname Boolean - Overrides the request's hostname with the
failover_hostname
.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeLoadBalancingOrigin
- string
- This specifies the name of the cookie that marks users' persistent sessions. The accompanying
edgeLoadBalancingDataCenter
behavior'sdescription
option specifies the cookie's value. - Description string
- Provides a description for the ELB origin, for your own reference.
- Enable
Session boolPersistence - 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.
- Hostname string
- Specifies the hostname associated with the ELB rule.
- Id string
- Specifies a unique descriptive string for this ELB origin. The value needs to match the
origin_id
specified by theedgeLoadBalancingDataCenter
behavior associated with this origin. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Session
Persistence stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- string
- This specifies the name of the cookie that marks users' persistent sessions. The accompanying
edgeLoadBalancingDataCenter
behavior'sdescription
option specifies the cookie's value. - Description string
- Provides a description for the ELB origin, for your own reference.
- Enable
Session boolPersistence - 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.
- Hostname string
- Specifies the hostname associated with the ELB rule.
- Id string
- Specifies a unique descriptive string for this ELB origin. The value needs to match the
origin_id
specified by theedgeLoadBalancingDataCenter
behavior associated with this origin. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Session
Persistence stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- String
- This specifies the name of the cookie that marks users' persistent sessions. The accompanying
edgeLoadBalancingDataCenter
behavior'sdescription
option specifies the cookie's value. - description String
- Provides a description for the ELB origin, for your own reference.
- enable
Session BooleanPersistence - 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.
- hostname String
- Specifies the hostname associated with the ELB rule.
- id String
- Specifies a unique descriptive string for this ELB origin. The value needs to match the
origin_id
specified by theedgeLoadBalancingDataCenter
behavior associated with this origin. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- session
Persistence StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- string
- This specifies the name of the cookie that marks users' persistent sessions. The accompanying
edgeLoadBalancingDataCenter
behavior'sdescription
option specifies the cookie's value. - description string
- Provides a description for the ELB origin, for your own reference.
- enable
Session booleanPersistence - 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.
- hostname string
- Specifies the hostname associated with the ELB rule.
- id string
- Specifies a unique descriptive string for this ELB origin. The value needs to match the
origin_id
specified by theedgeLoadBalancingDataCenter
behavior associated with this origin. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- session
Persistence stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- str
- This specifies the name of the cookie that marks users' persistent sessions. The accompanying
edgeLoadBalancingDataCenter
behavior'sdescription
option specifies the cookie's value. - description str
- Provides a description for the ELB origin, for your own reference.
- enable_
session_ boolpersistence - 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.
- hostname str
- Specifies the hostname associated with the ELB rule.
- id str
- Specifies a unique descriptive string for this ELB origin. The value needs to match the
origin_id
specified by theedgeLoadBalancingDataCenter
behavior associated with this origin. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- session_
persistence_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- String
- This specifies the name of the cookie that marks users' persistent sessions. The accompanying
edgeLoadBalancingDataCenter
behavior'sdescription
option specifies the cookie's value. - description String
- Provides a description for the ELB origin, for your own reference.
- enable
Session BooleanPersistence - 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.
- hostname String
- Specifies the hostname associated with the ELB rule.
- id String
- Specifies a unique descriptive string for this ELB origin. The value needs to match the
origin_id
specified by theedgeLoadBalancingDataCenter
behavior associated with this origin. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- session
Persistence StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeOriginAuthorization
- string
- Specifies the name of the cookie to use for authorization.
- Domain string
- Specify the cookie's domain, which needs to match the top-level domain of the
Host
header the origin server receives. - Enabled bool
- Enables the cookie-authorization behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Value string
- Specifies the value of the authorization cookie.
- string
- Specifies the name of the cookie to use for authorization.
- Domain string
- Specify the cookie's domain, which needs to match the top-level domain of the
Host
header the origin server receives. - Enabled bool
- Enables the cookie-authorization behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Value string
- Specifies the value of the authorization cookie.
- String
- Specifies the name of the cookie to use for authorization.
- domain String
- Specify the cookie's domain, which needs to match the top-level domain of the
Host
header the origin server receives. - enabled Boolean
- Enables the cookie-authorization behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value String
- Specifies the value of the authorization cookie.
- string
- Specifies the name of the cookie to use for authorization.
- domain string
- Specify the cookie's domain, which needs to match the top-level domain of the
Host
header the origin server receives. - enabled boolean
- Enables the cookie-authorization behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value string
- Specifies the value of the authorization cookie.
- str
- Specifies the name of the cookie to use for authorization.
- domain str
- Specify the cookie's domain, which needs to match the top-level domain of the
Host
header the origin server receives. - enabled bool
- Enables the cookie-authorization behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value str
- Specifies the value of the authorization cookie.
- String
- Specifies the name of the cookie to use for authorization.
- domain String
- Specify the cookie's domain, which needs to match the top-level domain of the
Host
header the origin server receives. - enabled Boolean
- Enables the cookie-authorization behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- value String
- Specifies the value of the authorization cookie.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirector
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Edge Redirector Cloudlet Policy - Specifies the Cloudlet policy as an object.
- int
- Identifies the Cloudlet shared policy to use with this behavior. Use the
Cloudlets API
to list available shared policies. - Enabled bool
- Enables the Edge Redirector Cloudlet.
- bool
- Whether you want to apply the Cloudlet shared policy to an unlimited number of properties within your account. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Edge Redirector Cloudlet Policy - Specifies the Cloudlet policy as an object.
- int
- Identifies the Cloudlet shared policy to use with this behavior. Use the
Cloudlets API
to list available shared policies. - Enabled bool
- Enables the Edge Redirector Cloudlet.
- bool
- Whether you want to apply the Cloudlet shared policy to an unlimited number of properties within your account. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Edge Redirector Cloudlet Policy - Specifies the Cloudlet policy as an object.
- Integer
- Identifies the Cloudlet shared policy to use with this behavior. Use the
Cloudlets API
to list available shared policies. - enabled Boolean
- Enables the Edge Redirector Cloudlet.
- Boolean
- Whether you want to apply the Cloudlet shared policy to an unlimited number of properties within your account. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Edge Redirector Cloudlet Policy - Specifies the Cloudlet policy as an object.
- number
- Identifies the Cloudlet shared policy to use with this behavior. Use the
Cloudlets API
to list available shared policies. - enabled boolean
- Enables the Edge Redirector Cloudlet.
- boolean
- Whether you want to apply the Cloudlet shared policy to an unlimited number of properties within your account. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior Edge Redirector Cloudlet Policy - Specifies the Cloudlet policy as an object.
- int
- Identifies the Cloudlet shared policy to use with this behavior. Use the
Cloudlets API
to list available shared policies. - enabled bool
- Enables the Edge Redirector Cloudlet.
- bool
- Whether you want to apply the Cloudlet shared policy to an unlimited number of properties within your account. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy Property Map - Specifies the Cloudlet policy as an object.
- Number
- Identifies the Cloudlet shared policy to use with this behavior. Use the
Cloudlets API
to list available shared policies. - enabled Boolean
- Enables the Edge Redirector Cloudlet.
- Boolean
- Whether you want to apply the Cloudlet shared policy to an unlimited number of properties within your account. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeRedirectorCloudletPolicy
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeScape
- Enabled bool
- When enabled, sends the
X-Akamai-Edgescape
request header to the origin. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- When enabled, sends the
X-Akamai-Edgescape
request header to the origin. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- When enabled, sends the
X-Akamai-Edgescape
request header to the origin. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- When enabled, sends the
X-Akamai-Edgescape
request header to the origin. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- When enabled, sends the
X-Akamai-Edgescape
request header to the origin. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- When enabled, sends the
X-Akamai-Edgescape
request header to the origin. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeSideIncludes
- Detect
Injection bool - Denies attempts to inject ESI code.
- Enable
Via boolHttp - Enable ESI only for content featuring the
Edge-control: dca=esi
HTTP response header. - Enabled bool
- Enables ESI processing.
- I18n
Charsets List<string> - Specifies the character sets to use when transcoding the ESI language,
UTF-8
andISO-8859-1
for example. - I18n
Status bool - Provides internationalization support for ESI.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Pass
Client boolIp - Allows edge servers to pass the client IP header to the ESI processor.
- bool
- Allows edge servers to pass your origin server's cookies to the ESI processor.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Detect
Injection bool - Denies attempts to inject ESI code.
- Enable
Via boolHttp - Enable ESI only for content featuring the
Edge-control: dca=esi
HTTP response header. - Enabled bool
- Enables ESI processing.
- I18n
Charsets []string - Specifies the character sets to use when transcoding the ESI language,
UTF-8
andISO-8859-1
for example. - I18n
Status bool - Provides internationalization support for ESI.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Pass
Client boolIp - Allows edge servers to pass the client IP header to the ESI processor.
- bool
- Allows edge servers to pass your origin server's cookies to the ESI processor.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- detect
Injection Boolean - Denies attempts to inject ESI code.
- enable
Via BooleanHttp - Enable ESI only for content featuring the
Edge-control: dca=esi
HTTP response header. - enabled Boolean
- Enables ESI processing.
- i18n
Charsets List<String> - Specifies the character sets to use when transcoding the ESI language,
UTF-8
andISO-8859-1
for example. - i18n
Status Boolean - Provides internationalization support for ESI.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- pass
Client BooleanIp - Allows edge servers to pass the client IP header to the ESI processor.
- Boolean
- Allows edge servers to pass your origin server's cookies to the ESI processor.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- detect
Injection boolean - Denies attempts to inject ESI code.
- enable
Via booleanHttp - Enable ESI only for content featuring the
Edge-control: dca=esi
HTTP response header. - enabled boolean
- Enables ESI processing.
- i18n
Charsets string[] - Specifies the character sets to use when transcoding the ESI language,
UTF-8
andISO-8859-1
for example. - i18n
Status boolean - Provides internationalization support for ESI.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- pass
Client booleanIp - Allows edge servers to pass the client IP header to the ESI processor.
- boolean
- Allows edge servers to pass your origin server's cookies to the ESI processor.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- detect_
injection bool - Denies attempts to inject ESI code.
- enable_
via_ boolhttp - Enable ESI only for content featuring the
Edge-control: dca=esi
HTTP response header. - enabled bool
- Enables ESI processing.
- i18n_
charsets Sequence[str] - Specifies the character sets to use when transcoding the ESI language,
UTF-8
andISO-8859-1
for example. - i18n_
status bool - Provides internationalization support for ESI.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- pass_
client_ boolip - Allows edge servers to pass the client IP header to the ESI processor.
- bool
- Allows edge servers to pass your origin server's cookies to the ESI processor.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- detect
Injection Boolean - Denies attempts to inject ESI code.
- enable
Via BooleanHttp - Enable ESI only for content featuring the
Edge-control: dca=esi
HTTP response header. - enabled Boolean
- Enables ESI processing.
- i18n
Charsets List<String> - Specifies the character sets to use when transcoding the ESI language,
UTF-8
andISO-8859-1
for example. - i18n
Status Boolean - Provides internationalization support for ESI.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- pass
Client BooleanIp - Allows edge servers to pass the client IP header to the ESI processor.
- Boolean
- Allows edge servers to pass your origin server's cookies to the ESI processor.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEdgeWorker
- Create
Edge stringWorker - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Edge
Worker stringId - Identifies the EdgeWorker application to apply to this rule's web traffic. You can use the
EdgeWorkers API
to get this value. - Enabled bool
- When enabled, applies specified EdgeWorker functionality to this rule's web traffic.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Resource
Tier string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Create
Edge stringWorker - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Edge
Worker stringId - Identifies the EdgeWorker application to apply to this rule's web traffic. You can use the
EdgeWorkers API
to get this value. - Enabled bool
- When enabled, applies specified EdgeWorker functionality to this rule's web traffic.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Resource
Tier string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- create
Edge StringWorker - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- edge
Worker StringId - Identifies the EdgeWorker application to apply to this rule's web traffic. You can use the
EdgeWorkers API
to get this value. - enabled Boolean
- When enabled, applies specified EdgeWorker functionality to this rule's web traffic.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- resource
Tier String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- create
Edge stringWorker - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- edge
Worker stringId - Identifies the EdgeWorker application to apply to this rule's web traffic. You can use the
EdgeWorkers API
to get this value. - enabled boolean
- When enabled, applies specified EdgeWorker functionality to this rule's web traffic.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- resource
Tier string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- create_
edge_ strworker - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- edge_
worker_ strid - Identifies the EdgeWorker application to apply to this rule's web traffic. You can use the
EdgeWorkers API
to get this value. - enabled bool
- When enabled, applies specified EdgeWorker functionality to this rule's web traffic.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- resource_
tier str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- create
Edge StringWorker - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- edge
Worker StringId - Identifies the EdgeWorker application to apply to this rule's web traffic. You can use the
EdgeWorkers API
to get this value. - enabled Boolean
- When enabled, applies specified EdgeWorker functionality to this rule's web traffic.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- resource
Tier String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedAkamaiProtocol
- Display string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Display string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- display String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- display string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- display str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- display String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorEnhancedProxyDetection
- Anonymous
Vpn string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Best
Practice stringAction - Specifies how to field the proxy request.
- Best
Practice stringRedirecturl - This specifies the URL to which to redirect requests.
- Detect
Anonymous boolVpn - This enables detection of requests from anonymous VPNs.
- Detect
Anonymous stringVpn Action - Specifies how to field anonymous VPN requests.
- Detect
Anonymous stringVpn Redirecturl - This specifies the URL to which to redirect anonymous VPN requests.
- Detect
Hosting boolProvider - This detects requests from a hosting provider.
- Detect
Hosting stringProvider Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from hosting providers. - Detect
Hosting stringProvider Redirecturl - This specifies the absolute URL to which to redirect requests from hosting providers.
- Detect
Public boolProxy - This enables detection of requests from public proxies.
- Detect
Public stringProxy Action - Specifies how to field public proxy requests.
- Detect
Public stringProxy Redirecturl - This specifies the URL to which to redirect public proxy requests.
- Detect
Residential boolProxy - This enables detection of requests from a residential proxy. See
Enhanced Proxy Detection with GeoGuard
and learn more about this GeoGuard category before enabling it. - Detect
Residential stringProxy Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from residential proxies. - Detect
Residential stringProxy Redirecturl - This specifies the URL to which to redirect requests.
- Detect
Smart boolDns Proxy - This enables detection of requests from smart DNS proxies.
- Detect
Smart stringDns Proxy Action - Specifies whether to
DENY
,ALLOW
, orREDIRECT
smart DNS proxy requests. - Detect
Smart stringDns Proxy Redirecturl - This specifies the URL to which to redirect DNS proxy requests.
- Detect
Tor boolExit Node - This enables detection of requests from Tor exit nodes.
- Detect
Tor stringExit Node Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from Tor exit nodes. - Detect
Tor stringExit Node Redirecturl - This specifies the URL to which to redirect requests from Tor exit nodes.
- Detect
Vpn boolData Center - This enables detection of requests from VPN data centers.
- Detect
Vpn stringData Center Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from VPN data centers. - Detect
Vpn stringData Center Redirecturl - This specifies the URL to which to redirect requests from VPN data centers.
- Enable
Configuration stringMode - Specifies how to field the proxy request.
- Enabled bool
- Applies GeoGuard proxy detection.
- Forward
Header boolEnrichment - Whether the Enhanced Proxy Detection (Akamai-EPD) header is included in the forward request to mark a connecting IP address as an anonymous proxy, with a two-letter designation. See the
epdForwardHeaderEnrichment
behavior for details. - Hosting
Provider string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Public
Proxy string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Residential
Proxy string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Smart
Dns stringProxy - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Tor
Exit stringNode - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Vpn
Data stringCenter - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Anonymous
Vpn string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Best
Practice stringAction - Specifies how to field the proxy request.
- Best
Practice stringRedirecturl - This specifies the URL to which to redirect requests.
- Detect
Anonymous boolVpn - This enables detection of requests from anonymous VPNs.
- Detect
Anonymous stringVpn Action - Specifies how to field anonymous VPN requests.
- Detect
Anonymous stringVpn Redirecturl - This specifies the URL to which to redirect anonymous VPN requests.
- Detect
Hosting boolProvider - This detects requests from a hosting provider.
- Detect
Hosting stringProvider Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from hosting providers. - Detect
Hosting stringProvider Redirecturl - This specifies the absolute URL to which to redirect requests from hosting providers.
- Detect
Public boolProxy - This enables detection of requests from public proxies.
- Detect
Public stringProxy Action - Specifies how to field public proxy requests.
- Detect
Public stringProxy Redirecturl - This specifies the URL to which to redirect public proxy requests.
- Detect
Residential boolProxy - This enables detection of requests from a residential proxy. See
Enhanced Proxy Detection with GeoGuard
and learn more about this GeoGuard category before enabling it. - Detect
Residential stringProxy Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from residential proxies. - Detect
Residential stringProxy Redirecturl - This specifies the URL to which to redirect requests.
- Detect
Smart boolDns Proxy - This enables detection of requests from smart DNS proxies.
- Detect
Smart stringDns Proxy Action - Specifies whether to
DENY
,ALLOW
, orREDIRECT
smart DNS proxy requests. - Detect
Smart stringDns Proxy Redirecturl - This specifies the URL to which to redirect DNS proxy requests.
- Detect
Tor boolExit Node - This enables detection of requests from Tor exit nodes.
- Detect
Tor stringExit Node Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from Tor exit nodes. - Detect
Tor stringExit Node Redirecturl - This specifies the URL to which to redirect requests from Tor exit nodes.
- Detect
Vpn boolData Center - This enables detection of requests from VPN data centers.
- Detect
Vpn stringData Center Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from VPN data centers. - Detect
Vpn stringData Center Redirecturl - This specifies the URL to which to redirect requests from VPN data centers.
- Enable
Configuration stringMode - Specifies how to field the proxy request.
- Enabled bool
- Applies GeoGuard proxy detection.
- Forward
Header boolEnrichment - Whether the Enhanced Proxy Detection (Akamai-EPD) header is included in the forward request to mark a connecting IP address as an anonymous proxy, with a two-letter designation. See the
epdForwardHeaderEnrichment
behavior for details. - Hosting
Provider string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Public
Proxy string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Residential
Proxy string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Smart
Dns stringProxy - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Tor
Exit stringNode - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Vpn
Data stringCenter - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- anonymous
Vpn String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- best
Practice StringAction - Specifies how to field the proxy request.
- best
Practice StringRedirecturl - This specifies the URL to which to redirect requests.
- detect
Anonymous BooleanVpn - This enables detection of requests from anonymous VPNs.
- detect
Anonymous StringVpn Action - Specifies how to field anonymous VPN requests.
- detect
Anonymous StringVpn Redirecturl - This specifies the URL to which to redirect anonymous VPN requests.
- detect
Hosting BooleanProvider - This detects requests from a hosting provider.
- detect
Hosting StringProvider Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from hosting providers. - detect
Hosting StringProvider Redirecturl - This specifies the absolute URL to which to redirect requests from hosting providers.
- detect
Public BooleanProxy - This enables detection of requests from public proxies.
- detect
Public StringProxy Action - Specifies how to field public proxy requests.
- detect
Public StringProxy Redirecturl - This specifies the URL to which to redirect public proxy requests.
- detect
Residential BooleanProxy - This enables detection of requests from a residential proxy. See
Enhanced Proxy Detection with GeoGuard
and learn more about this GeoGuard category before enabling it. - detect
Residential StringProxy Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from residential proxies. - detect
Residential StringProxy Redirecturl - This specifies the URL to which to redirect requests.
- detect
Smart BooleanDns Proxy - This enables detection of requests from smart DNS proxies.
- detect
Smart StringDns Proxy Action - Specifies whether to
DENY
,ALLOW
, orREDIRECT
smart DNS proxy requests. - detect
Smart StringDns Proxy Redirecturl - This specifies the URL to which to redirect DNS proxy requests.
- detect
Tor BooleanExit Node - This enables detection of requests from Tor exit nodes.
- detect
Tor StringExit Node Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from Tor exit nodes. - detect
Tor StringExit Node Redirecturl - This specifies the URL to which to redirect requests from Tor exit nodes.
- detect
Vpn BooleanData Center - This enables detection of requests from VPN data centers.
- detect
Vpn StringData Center Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from VPN data centers. - detect
Vpn StringData Center Redirecturl - This specifies the URL to which to redirect requests from VPN data centers.
- enable
Configuration StringMode - Specifies how to field the proxy request.
- enabled Boolean
- Applies GeoGuard proxy detection.
- forward
Header BooleanEnrichment - Whether the Enhanced Proxy Detection (Akamai-EPD) header is included in the forward request to mark a connecting IP address as an anonymous proxy, with a two-letter designation. See the
epdForwardHeaderEnrichment
behavior for details. - hosting
Provider String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- public
Proxy String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- residential
Proxy String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- smart
Dns StringProxy - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- tor
Exit StringNode - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- vpn
Data StringCenter - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- anonymous
Vpn string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- best
Practice stringAction - Specifies how to field the proxy request.
- best
Practice stringRedirecturl - This specifies the URL to which to redirect requests.
- detect
Anonymous booleanVpn - This enables detection of requests from anonymous VPNs.
- detect
Anonymous stringVpn Action - Specifies how to field anonymous VPN requests.
- detect
Anonymous stringVpn Redirecturl - This specifies the URL to which to redirect anonymous VPN requests.
- detect
Hosting booleanProvider - This detects requests from a hosting provider.
- detect
Hosting stringProvider Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from hosting providers. - detect
Hosting stringProvider Redirecturl - This specifies the absolute URL to which to redirect requests from hosting providers.
- detect
Public booleanProxy - This enables detection of requests from public proxies.
- detect
Public stringProxy Action - Specifies how to field public proxy requests.
- detect
Public stringProxy Redirecturl - This specifies the URL to which to redirect public proxy requests.
- detect
Residential booleanProxy - This enables detection of requests from a residential proxy. See
Enhanced Proxy Detection with GeoGuard
and learn more about this GeoGuard category before enabling it. - detect
Residential stringProxy Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from residential proxies. - detect
Residential stringProxy Redirecturl - This specifies the URL to which to redirect requests.
- detect
Smart booleanDns Proxy - This enables detection of requests from smart DNS proxies.
- detect
Smart stringDns Proxy Action - Specifies whether to
DENY
,ALLOW
, orREDIRECT
smart DNS proxy requests. - detect
Smart stringDns Proxy Redirecturl - This specifies the URL to which to redirect DNS proxy requests.
- detect
Tor booleanExit Node - This enables detection of requests from Tor exit nodes.
- detect
Tor stringExit Node Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from Tor exit nodes. - detect
Tor stringExit Node Redirecturl - This specifies the URL to which to redirect requests from Tor exit nodes.
- detect
Vpn booleanData Center - This enables detection of requests from VPN data centers.
- detect
Vpn stringData Center Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from VPN data centers. - detect
Vpn stringData Center Redirecturl - This specifies the URL to which to redirect requests from VPN data centers.
- enable
Configuration stringMode - Specifies how to field the proxy request.
- enabled boolean
- Applies GeoGuard proxy detection.
- forward
Header booleanEnrichment - Whether the Enhanced Proxy Detection (Akamai-EPD) header is included in the forward request to mark a connecting IP address as an anonymous proxy, with a two-letter designation. See the
epdForwardHeaderEnrichment
behavior for details. - hosting
Provider string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- public
Proxy string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- residential
Proxy string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- smart
Dns stringProxy - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- tor
Exit stringNode - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- vpn
Data stringCenter - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- anonymous_
vpn str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- best_
practice_ straction - Specifies how to field the proxy request.
- best_
practice_ strredirecturl - This specifies the URL to which to redirect requests.
- detect_
anonymous_ boolvpn - This enables detection of requests from anonymous VPNs.
- detect_
anonymous_ strvpn_ action - Specifies how to field anonymous VPN requests.
- detect_
anonymous_ strvpn_ redirecturl - This specifies the URL to which to redirect anonymous VPN requests.
- detect_
hosting_ boolprovider - This detects requests from a hosting provider.
- detect_
hosting_ strprovider_ action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from hosting providers. - detect_
hosting_ strprovider_ redirecturl - This specifies the absolute URL to which to redirect requests from hosting providers.
- detect_
public_ boolproxy - This enables detection of requests from public proxies.
- detect_
public_ strproxy_ action - Specifies how to field public proxy requests.
- detect_
public_ strproxy_ redirecturl - This specifies the URL to which to redirect public proxy requests.
- detect_
residential_ boolproxy - This enables detection of requests from a residential proxy. See
Enhanced Proxy Detection with GeoGuard
and learn more about this GeoGuard category before enabling it. - detect_
residential_ strproxy_ action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from residential proxies. - detect_
residential_ strproxy_ redirecturl - This specifies the URL to which to redirect requests.
- detect_
smart_ booldns_ proxy - This enables detection of requests from smart DNS proxies.
- detect_
smart_ strdns_ proxy_ action - Specifies whether to
DENY
,ALLOW
, orREDIRECT
smart DNS proxy requests. - detect_
smart_ strdns_ proxy_ redirecturl - This specifies the URL to which to redirect DNS proxy requests.
- detect_
tor_ boolexit_ node - This enables detection of requests from Tor exit nodes.
- detect_
tor_ strexit_ node_ action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from Tor exit nodes. - detect_
tor_ strexit_ node_ redirecturl - This specifies the URL to which to redirect requests from Tor exit nodes.
- detect_
vpn_ booldata_ center - This enables detection of requests from VPN data centers.
- detect_
vpn_ strdata_ center_ action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from VPN data centers. - detect_
vpn_ strdata_ center_ redirecturl - This specifies the URL to which to redirect requests from VPN data centers.
- enable_
configuration_ strmode - Specifies how to field the proxy request.
- enabled bool
- Applies GeoGuard proxy detection.
- forward_
header_ boolenrichment - Whether the Enhanced Proxy Detection (Akamai-EPD) header is included in the forward request to mark a connecting IP address as an anonymous proxy, with a two-letter designation. See the
epdForwardHeaderEnrichment
behavior for details. - hosting_
provider str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- public_
proxy str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- residential_
proxy str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- smart_
dns_ strproxy - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- tor_
exit_ strnode - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- vpn_
data_ strcenter - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- anonymous
Vpn String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- best
Practice StringAction - Specifies how to field the proxy request.
- best
Practice StringRedirecturl - This specifies the URL to which to redirect requests.
- detect
Anonymous BooleanVpn - This enables detection of requests from anonymous VPNs.
- detect
Anonymous StringVpn Action - Specifies how to field anonymous VPN requests.
- detect
Anonymous StringVpn Redirecturl - This specifies the URL to which to redirect anonymous VPN requests.
- detect
Hosting BooleanProvider - This detects requests from a hosting provider.
- detect
Hosting StringProvider Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from hosting providers. - detect
Hosting StringProvider Redirecturl - This specifies the absolute URL to which to redirect requests from hosting providers.
- detect
Public BooleanProxy - This enables detection of requests from public proxies.
- detect
Public StringProxy Action - Specifies how to field public proxy requests.
- detect
Public StringProxy Redirecturl - This specifies the URL to which to redirect public proxy requests.
- detect
Residential BooleanProxy - This enables detection of requests from a residential proxy. See
Enhanced Proxy Detection with GeoGuard
and learn more about this GeoGuard category before enabling it. - detect
Residential StringProxy Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from residential proxies. - detect
Residential StringProxy Redirecturl - This specifies the URL to which to redirect requests.
- detect
Smart BooleanDns Proxy - This enables detection of requests from smart DNS proxies.
- detect
Smart StringDns Proxy Action - Specifies whether to
DENY
,ALLOW
, orREDIRECT
smart DNS proxy requests. - detect
Smart StringDns Proxy Redirecturl - This specifies the URL to which to redirect DNS proxy requests.
- detect
Tor BooleanExit Node - This enables detection of requests from Tor exit nodes.
- detect
Tor StringExit Node Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from Tor exit nodes. - detect
Tor StringExit Node Redirecturl - This specifies the URL to which to redirect requests from Tor exit nodes.
- detect
Vpn BooleanData Center - This enables detection of requests from VPN data centers.
- detect
Vpn StringData Center Action - This specifies whether to
DENY
,ALLOW
, orREDIRECT
requests from VPN data centers. - detect
Vpn StringData Center Redirecturl - This specifies the URL to which to redirect requests from VPN data centers.
- enable
Configuration StringMode - Specifies how to field the proxy request.
- enabled Boolean
- Applies GeoGuard proxy detection.
- forward
Header BooleanEnrichment - Whether the Enhanced Proxy Detection (Akamai-EPD) header is included in the forward request to mark a connecting IP address as an anonymous proxy, with a two-letter designation. See the
epdForwardHeaderEnrichment
behavior for details. - hosting
Provider String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- public
Proxy String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- residential
Proxy String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- smart
Dns StringProxy - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- tor
Exit StringNode - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- vpn
Data StringCenter - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorEpdForwardHeaderEnrichment
- Enabled bool
- Sends the Enhanced Proxy Detection (
Akamai-EPD
) header in the forward request to determine whether the connecting IP address is an anonymous proxy. The header can contain one or more two-letter codes that indicate the IP address type detected by edge servers: - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Sends the Enhanced Proxy Detection (
Akamai-EPD
) header in the forward request to determine whether the connecting IP address is an anonymous proxy. The header can contain one or more two-letter codes that indicate the IP address type detected by edge servers: - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Sends the Enhanced Proxy Detection (
Akamai-EPD
) header in the forward request to determine whether the connecting IP address is an anonymous proxy. The header can contain one or more two-letter codes that indicate the IP address type detected by edge servers: - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Sends the Enhanced Proxy Detection (
Akamai-EPD
) header in the forward request to determine whether the connecting IP address is an anonymous proxy. The header can contain one or more two-letter codes that indicate the IP address type detected by edge servers: - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Sends the Enhanced Proxy Detection (
Akamai-EPD
) header in the forward request to determine whether the connecting IP address is an anonymous proxy. The header can contain one or more two-letter codes that indicate the IP address type detected by edge servers: - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Sends the Enhanced Proxy Detection (
Akamai-EPD
) header in the forward request to determine whether the connecting IP address is an anonymous proxy. The header can contain one or more two-letter codes that indicate the IP address type detected by edge servers: - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorFailAction
- Action
Type string - Specifies the basic action to take when there is a failure to contact the origin.
- Allow
Fcm boolParent Override - Cex
Custom boolPath - Specifies a custom path.
- Cex
Hostname string - Specifies a hostname.
- Cex
Path string - Specifies a custom path.
- Content
Custom boolPath - Specifies a custom redirect path.
- Content
Hostname string - Specifies the static hostname for the alternate redirect.
- Content
Path string - Specifies a custom redirect path.
- Cp
Code GetProperty Rules Builder Rules V20230105Behavior Fail Action Cp Code - Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Dynamic
Custom boolPath - Allows you to modify the original requested path.
- Dynamic
Method string - Specifies the redirect method.
- Dynamic
Path string - Specifies the new path.
- Enabled bool
- When enabled in case of a failure to contact the origin, the current behavior applies.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Modify
Protocol bool - Modifies the redirect's protocol using the value of the
protocol
field. - Net
Storage GetHostname Property Rules Builder Rules V20230105Behavior Fail Action Net Storage Hostname - When the
actionType
isRECREATED_NS
, specifies theNetStorage
origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin'sid
. - Net
Storage stringPath - When the
actionType
isRECREATED_NS
, specifies the path for theNetStorage
request. - Preserve
Query boolString - When using either
contentCustomPath
,cexCustomPath
,dynamicCustomPath
, orredirectCustomPath
to specify a custom path, enabling this passes in the original request's query string as part of the path. - Protocol string
- When the
actionType
isREDIRECT
andmodifyProtocol
is enabled, this specifies the redirect's protocol. - Redirect
Custom boolPath - Uses the
redirectPath
to customize a new path. - Redirect
Hostname string - When the
actionType
isREDIRECT
and theredirectHostnameType
isALTERNATE
, this specifies the hostname for the redirect. - Redirect
Hostname stringType - Whether to preserve or customize the hostname.
- Redirect
Method int - Specifies the HTTP response code.
- Redirect
Path string - Specifies a new path.
- Saas
Cname boolEnabled - Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
- Saas
Cname intLevel - Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
- string
- Specifies the name of the cookie that identifies this SaaS dynamic failaction.
- Saas
Query stringString - Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
- Saas
Regex string - Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
- Saas
Replace string - Specifies the replacement pattern that defines the SaaS dynamic failaction.
- Saas
Suffix string - Specifies the static portion of the SaaS dynamic failaction.
- Saas
Type string - Identifies the component of the request that identifies the SaaS dynamic fail action.
- Status
Code int - Assigns a new HTTP status code to the failure response.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Action
Type string - Specifies the basic action to take when there is a failure to contact the origin.
- Allow
Fcm boolParent Override - Cex
Custom boolPath - Specifies a custom path.
- Cex
Hostname string - Specifies a hostname.
- Cex
Path string - Specifies a custom path.
- Content
Custom boolPath - Specifies a custom redirect path.
- Content
Hostname string - Specifies the static hostname for the alternate redirect.
- Content
Path string - Specifies a custom redirect path.
- Cp
Code GetProperty Rules Builder Rules V20230105Behavior Fail Action Cp Code - Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Dynamic
Custom boolPath - Allows you to modify the original requested path.
- Dynamic
Method string - Specifies the redirect method.
- Dynamic
Path string - Specifies the new path.
- Enabled bool
- When enabled in case of a failure to contact the origin, the current behavior applies.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Modify
Protocol bool - Modifies the redirect's protocol using the value of the
protocol
field. - Net
Storage GetHostname Property Rules Builder Rules V20230105Behavior Fail Action Net Storage Hostname - When the
actionType
isRECREATED_NS
, specifies theNetStorage
origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin'sid
. - Net
Storage stringPath - When the
actionType
isRECREATED_NS
, specifies the path for theNetStorage
request. - Preserve
Query boolString - When using either
contentCustomPath
,cexCustomPath
,dynamicCustomPath
, orredirectCustomPath
to specify a custom path, enabling this passes in the original request's query string as part of the path. - Protocol string
- When the
actionType
isREDIRECT
andmodifyProtocol
is enabled, this specifies the redirect's protocol. - Redirect
Custom boolPath - Uses the
redirectPath
to customize a new path. - Redirect
Hostname string - When the
actionType
isREDIRECT
and theredirectHostnameType
isALTERNATE
, this specifies the hostname for the redirect. - Redirect
Hostname stringType - Whether to preserve or customize the hostname.
- Redirect
Method int - Specifies the HTTP response code.
- Redirect
Path string - Specifies a new path.
- Saas
Cname boolEnabled - Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
- Saas
Cname intLevel - Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
- string
- Specifies the name of the cookie that identifies this SaaS dynamic failaction.
- Saas
Query stringString - Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
- Saas
Regex string - Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
- Saas
Replace string - Specifies the replacement pattern that defines the SaaS dynamic failaction.
- Saas
Suffix string - Specifies the static portion of the SaaS dynamic failaction.
- Saas
Type string - Identifies the component of the request that identifies the SaaS dynamic fail action.
- Status
Code int - Assigns a new HTTP status code to the failure response.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action
Type String - Specifies the basic action to take when there is a failure to contact the origin.
- allow
Fcm BooleanParent Override - cex
Custom BooleanPath - Specifies a custom path.
- cex
Hostname String - Specifies a hostname.
- cex
Path String - Specifies a custom path.
- content
Custom BooleanPath - Specifies a custom redirect path.
- content
Hostname String - Specifies the static hostname for the alternate redirect.
- content
Path String - Specifies a custom redirect path.
- cp
Code GetProperty Rules Builder Rules V20230105Behavior Fail Action Cp Code - Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - dynamic
Custom BooleanPath - Allows you to modify the original requested path.
- dynamic
Method String - Specifies the redirect method.
- dynamic
Path String - Specifies the new path.
- enabled Boolean
- When enabled in case of a failure to contact the origin, the current behavior applies.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- modify
Protocol Boolean - Modifies the redirect's protocol using the value of the
protocol
field. - net
Storage GetHostname Property Rules Builder Rules V20230105Behavior Fail Action Net Storage Hostname - When the
actionType
isRECREATED_NS
, specifies theNetStorage
origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin'sid
. - net
Storage StringPath - When the
actionType
isRECREATED_NS
, specifies the path for theNetStorage
request. - preserve
Query BooleanString - When using either
contentCustomPath
,cexCustomPath
,dynamicCustomPath
, orredirectCustomPath
to specify a custom path, enabling this passes in the original request's query string as part of the path. - protocol String
- When the
actionType
isREDIRECT
andmodifyProtocol
is enabled, this specifies the redirect's protocol. - redirect
Custom BooleanPath - Uses the
redirectPath
to customize a new path. - redirect
Hostname String - When the
actionType
isREDIRECT
and theredirectHostnameType
isALTERNATE
, this specifies the hostname for the redirect. - redirect
Hostname StringType - Whether to preserve or customize the hostname.
- redirect
Method Integer - Specifies the HTTP response code.
- redirect
Path String - Specifies a new path.
- saas
Cname BooleanEnabled - Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
- saas
Cname IntegerLevel - Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
- String
- Specifies the name of the cookie that identifies this SaaS dynamic failaction.
- saas
Query StringString - Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
- saas
Regex String - Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
- saas
Replace String - Specifies the replacement pattern that defines the SaaS dynamic failaction.
- saas
Suffix String - Specifies the static portion of the SaaS dynamic failaction.
- saas
Type String - Identifies the component of the request that identifies the SaaS dynamic fail action.
- status
Code Integer - Assigns a new HTTP status code to the failure response.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action
Type string - Specifies the basic action to take when there is a failure to contact the origin.
- allow
Fcm booleanParent Override - cex
Custom booleanPath - Specifies a custom path.
- cex
Hostname string - Specifies a hostname.
- cex
Path string - Specifies a custom path.
- content
Custom booleanPath - Specifies a custom redirect path.
- content
Hostname string - Specifies the static hostname for the alternate redirect.
- content
Path string - Specifies a custom redirect path.
- cp
Code GetProperty Rules Builder Rules V20230105Behavior Fail Action Cp Code - Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - dynamic
Custom booleanPath - Allows you to modify the original requested path.
- dynamic
Method string - Specifies the redirect method.
- dynamic
Path string - Specifies the new path.
- enabled boolean
- When enabled in case of a failure to contact the origin, the current behavior applies.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- modify
Protocol boolean - Modifies the redirect's protocol using the value of the
protocol
field. - net
Storage GetHostname Property Rules Builder Rules V20230105Behavior Fail Action Net Storage Hostname - When the
actionType
isRECREATED_NS
, specifies theNetStorage
origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin'sid
. - net
Storage stringPath - When the
actionType
isRECREATED_NS
, specifies the path for theNetStorage
request. - preserve
Query booleanString - When using either
contentCustomPath
,cexCustomPath
,dynamicCustomPath
, orredirectCustomPath
to specify a custom path, enabling this passes in the original request's query string as part of the path. - protocol string
- When the
actionType
isREDIRECT
andmodifyProtocol
is enabled, this specifies the redirect's protocol. - redirect
Custom booleanPath - Uses the
redirectPath
to customize a new path. - redirect
Hostname string - When the
actionType
isREDIRECT
and theredirectHostnameType
isALTERNATE
, this specifies the hostname for the redirect. - redirect
Hostname stringType - Whether to preserve or customize the hostname.
- redirect
Method number - Specifies the HTTP response code.
- redirect
Path string - Specifies a new path.
- saas
Cname booleanEnabled - Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
- saas
Cname numberLevel - Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
- string
- Specifies the name of the cookie that identifies this SaaS dynamic failaction.
- saas
Query stringString - Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
- saas
Regex string - Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
- saas
Replace string - Specifies the replacement pattern that defines the SaaS dynamic failaction.
- saas
Suffix string - Specifies the static portion of the SaaS dynamic failaction.
- saas
Type string - Identifies the component of the request that identifies the SaaS dynamic fail action.
- status
Code number - Assigns a new HTTP status code to the failure response.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action_
type str - Specifies the basic action to take when there is a failure to contact the origin.
- allow_
fcm_ boolparent_ override - cex_
custom_ boolpath - Specifies a custom path.
- cex_
hostname str - Specifies a hostname.
- cex_
path str - Specifies a custom path.
- content_
custom_ boolpath - Specifies a custom redirect path.
- content_
hostname str - Specifies the static hostname for the alternate redirect.
- content_
path str - Specifies a custom redirect path.
- cp_
code GetProperty Rules Builder Rules V20230105Behavior Fail Action Cp Code - Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - dynamic_
custom_ boolpath - Allows you to modify the original requested path.
- dynamic_
method str - Specifies the redirect method.
- dynamic_
path str - Specifies the new path.
- enabled bool
- When enabled in case of a failure to contact the origin, the current behavior applies.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- modify_
protocol bool - Modifies the redirect's protocol using the value of the
protocol
field. - net_
storage_ Gethostname Property Rules Builder Rules V20230105Behavior Fail Action Net Storage Hostname - When the
actionType
isRECREATED_NS
, specifies theNetStorage
origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin'sid
. - net_
storage_ strpath - When the
actionType
isRECREATED_NS
, specifies the path for theNetStorage
request. - preserve_
query_ boolstring - When using either
contentCustomPath
,cexCustomPath
,dynamicCustomPath
, orredirectCustomPath
to specify a custom path, enabling this passes in the original request's query string as part of the path. - protocol str
- When the
actionType
isREDIRECT
andmodifyProtocol
is enabled, this specifies the redirect's protocol. - redirect_
custom_ boolpath - Uses the
redirectPath
to customize a new path. - redirect_
hostname str - When the
actionType
isREDIRECT
and theredirectHostnameType
isALTERNATE
, this specifies the hostname for the redirect. - redirect_
hostname_ strtype - Whether to preserve or customize the hostname.
- redirect_
method int - Specifies the HTTP response code.
- redirect_
path str - Specifies a new path.
- saas_
cname_ boolenabled - Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
- saas_
cname_ intlevel - Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
- str
- Specifies the name of the cookie that identifies this SaaS dynamic failaction.
- saas_
query_ strstring - Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
- saas_
regex str - Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
- saas_
replace str - Specifies the replacement pattern that defines the SaaS dynamic failaction.
- saas_
suffix str - Specifies the static portion of the SaaS dynamic failaction.
- saas_
type str - Identifies the component of the request that identifies the SaaS dynamic fail action.
- status_
code int - Assigns a new HTTP status code to the failure response.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action
Type String - Specifies the basic action to take when there is a failure to contact the origin.
- allow
Fcm BooleanParent Override - cex
Custom BooleanPath - Specifies a custom path.
- cex
Hostname String - Specifies a hostname.
- cex
Path String - Specifies a custom path.
- content
Custom BooleanPath - Specifies a custom redirect path.
- content
Hostname String - Specifies the static hostname for the alternate redirect.
- content
Path String - Specifies a custom redirect path.
- cp
Code Property Map - Specifies a CP code for which to log errors for the NetStorage location. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - dynamic
Custom BooleanPath - Allows you to modify the original requested path.
- dynamic
Method String - Specifies the redirect method.
- dynamic
Path String - Specifies the new path.
- enabled Boolean
- When enabled in case of a failure to contact the origin, the current behavior applies.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- modify
Protocol Boolean - Modifies the redirect's protocol using the value of the
protocol
field. - net
Storage Property MapHostname - When the
actionType
isRECREATED_NS
, specifies theNetStorage
origin to serve the alternate content. Contact Akamai Professional Services for your NetStorage origin'sid
. - net
Storage StringPath - When the
actionType
isRECREATED_NS
, specifies the path for theNetStorage
request. - preserve
Query BooleanString - When using either
contentCustomPath
,cexCustomPath
,dynamicCustomPath
, orredirectCustomPath
to specify a custom path, enabling this passes in the original request's query string as part of the path. - protocol String
- When the
actionType
isREDIRECT
andmodifyProtocol
is enabled, this specifies the redirect's protocol. - redirect
Custom BooleanPath - Uses the
redirectPath
to customize a new path. - redirect
Hostname String - When the
actionType
isREDIRECT
and theredirectHostnameType
isALTERNATE
, this specifies the hostname for the redirect. - redirect
Hostname StringType - Whether to preserve or customize the hostname.
- redirect
Method Number - Specifies the HTTP response code.
- redirect
Path String - Specifies a new path.
- saas
Cname BooleanEnabled - Specifies whether to use a CNAME chain to determine the hostname for the SaaS dynamic failaction.
- saas
Cname NumberLevel - Specifies the number of elements in the CNAME chain backwards from the edge hostname that determines the hostname for the SaaS dynamic failaction.
- String
- Specifies the name of the cookie that identifies this SaaS dynamic failaction.
- saas
Query StringString - Specifies the name of the query parameter that identifies this SaaS dynamic failaction.
- saas
Regex String - Specifies the substitution pattern (a Perl-compatible regular expression) that defines the SaaS dynamic failaction.
- saas
Replace String - Specifies the replacement pattern that defines the SaaS dynamic failaction.
- saas
Suffix String - Specifies the static portion of the SaaS dynamic failaction.
- saas
Type String - Identifies the component of the request that identifies the SaaS dynamic fail action.
- status
Code Number - Assigns a new HTTP status code to the failure response.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCode
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Fail Action Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Fail Action Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Fail Action Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Fail Action Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Fail Action Cp Code Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorFailActionCpCodeCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorFailActionNetStorageHostname
- Cp
Code int - Download
Domain stringName - G2o
Token string
- Cp
Code int - Download
Domain stringName - G2o
Token string
- cp
Code Integer - download
Domain StringName - g2o
Token String
- cp
Code number - download
Domain stringName - g2o
Token string
- cp_
code int - download_
domain_ strname - g2o_
token str
- cp
Code Number - download
Domain StringName - g2o
Token String
GetPropertyRulesBuilderRulesV20230105BehaviorFailoverBotManagerFeatureCompatibility
- Compatibility bool
- This behavior does not include any options. Specifying the behavior itself enables it.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Compatibility bool
- This behavior does not include any options. Specifying the behavior itself enables it.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- compatibility Boolean
- This behavior does not include any options. Specifying the behavior itself enables it.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- compatibility boolean
- This behavior does not include any options. Specifying the behavior itself enables it.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- compatibility bool
- This behavior does not include any options. Specifying the behavior itself enables it.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- compatibility Boolean
- This behavior does not include any options. Specifying the behavior itself enables it.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorFastInvalidate
- Enabled bool
- When enabled, forces a validation test for all edge content to which the behavior applies.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- When enabled, forces a validation test for all edge content to which the behavior applies.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- When enabled, forces a validation test for all edge content to which the behavior applies.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- When enabled, forces a validation test for all edge content to which the behavior applies.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- When enabled, forces a validation test for all edge content to which the behavior applies.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- When enabled, forces a validation test for all edge content to which the behavior applies.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketing
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Enables the Cloud Marketing Cloudlet.
- Java
Script stringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Media
Math stringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Enables the Cloud Marketing Cloudlet.
- Java
Script stringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Media
Math stringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Cloudlet Policy - Identifies the Cloudlet policy.
- enabled Boolean
- Enables the Cloud Marketing Cloudlet.
- java
Script StringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- media
Math StringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Cloudlet Policy - Identifies the Cloudlet policy.
- enabled boolean
- Enables the Cloud Marketing Cloudlet.
- java
Script stringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- media
Math stringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Cloudlet Policy - Identifies the Cloudlet policy.
- enabled bool
- Enables the Cloud Marketing Cloudlet.
- java_
script_ strinsertion_ rule - Select how to insert the MediaMath JavaScript reference script.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- media_
math_ strprefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy Property Map - Identifies the Cloudlet policy.
- enabled Boolean
- Enables the Cloud Marketing Cloudlet.
- java
Script StringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- media
Math StringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingCloudletPolicy
GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlus
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Plus Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Enables the Cloud Marketing Plus Cloudlet.
- Java
Script stringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Media
Math stringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Plus Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Enables the Cloud Marketing Plus Cloudlet.
- Java
Script stringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Media
Math stringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Plus Cloudlet Policy - Identifies the Cloudlet policy.
- enabled Boolean
- Enables the Cloud Marketing Plus Cloudlet.
- java
Script StringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- media
Math StringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Plus Cloudlet Policy - Identifies the Cloudlet policy.
- enabled boolean
- Enables the Cloud Marketing Plus Cloudlet.
- java
Script stringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- media
Math stringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior First Party Marketing Plus Cloudlet Policy - Identifies the Cloudlet policy.
- enabled bool
- Enables the Cloud Marketing Plus Cloudlet.
- java_
script_ strinsertion_ rule - Select how to insert the MediaMath JavaScript reference script.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- media_
math_ strprefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy Property Map - Identifies the Cloudlet policy.
- enabled Boolean
- Enables the Cloud Marketing Plus Cloudlet.
- java
Script StringInsertion Rule - Select how to insert the MediaMath JavaScript reference script.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- media
Math StringPrefix - 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 forwww.example.com/dir
, the new URL iswww.example.com/mmath/dir
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorFirstPartyMarketingPlusCloudletPolicy
GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewrite
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite Cloudlet Policy - Identifies the Cloudlet policy.
- int
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - Enabled bool
- Enables the Forward Rewrite Cloudlet behavior.
- bool
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite Cloudlet Policy - Identifies the Cloudlet policy.
- int
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - Enabled bool
- Enables the Forward Rewrite Cloudlet behavior.
- bool
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite Cloudlet Policy - Identifies the Cloudlet policy.
- Integer
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - enabled Boolean
- Enables the Forward Rewrite Cloudlet behavior.
- Boolean
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite Cloudlet Policy - Identifies the Cloudlet policy.
- number
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - enabled boolean
- Enables the Forward Rewrite Cloudlet behavior.
- boolean
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior Forward Rewrite Cloudlet Policy - Identifies the Cloudlet policy.
- int
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - enabled bool
- Enables the Forward Rewrite Cloudlet behavior.
- bool
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy Property Map - Identifies the Cloudlet policy.
- Number
- This identifies the Cloudlet shared policy to use with this behavior. You can list available shared policies with the
Cloudlets API
. - enabled Boolean
- Enables the Forward Rewrite Cloudlet behavior.
- Boolean
- Whether you want to use a shared policy for a Cloudlet. Learn more about shared policies and how to create them in
Cloudlets Policy Manager
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorForwardRewriteCloudletPolicy
GetPropertyRulesBuilderRulesV20230105BehaviorFrontEndOptimization
- Enabled bool
- Enables the front-end optimization behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the front-end optimization behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the front-end optimization behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the front-end optimization behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the front-end optimization behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the front-end optimization behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorG2oheader
- Custom
Sign List<string>Strings - Specifies the set of data to be encrypted as a combination of concatenated strings.
- Data
Header string - Specifies the name of the header that contains the request data that needs to be encrypted.
- Enabled bool
- Enables the g2o verification behavior.
- Encoding
Version int - Specifies the version of the encryption algorithm as an integer from
1
through5
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Nonce string
- Specifies the cryptographic
nonce
string. - Secret
Key string - Specifies the shared secret key.
- Signed
Header string - Specifies the name of the header containing encrypted request data.
- Template
Uuid string - This option is for internal usage only.
- Use
Custom boolSign String - 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. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Custom
Sign []stringStrings - Specifies the set of data to be encrypted as a combination of concatenated strings.
- Data
Header string - Specifies the name of the header that contains the request data that needs to be encrypted.
- Enabled bool
- Enables the g2o verification behavior.
- Encoding
Version int - Specifies the version of the encryption algorithm as an integer from
1
through5
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Nonce string
- Specifies the cryptographic
nonce
string. - Secret
Key string - Specifies the shared secret key.
- Signed
Header string - Specifies the name of the header containing encrypted request data.
- Template
Uuid string - This option is for internal usage only.
- Use
Custom boolSign String - 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. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Sign List<String>Strings - Specifies the set of data to be encrypted as a combination of concatenated strings.
- data
Header String - Specifies the name of the header that contains the request data that needs to be encrypted.
- enabled Boolean
- Enables the g2o verification behavior.
- encoding
Version Integer - Specifies the version of the encryption algorithm as an integer from
1
through5
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- nonce String
- Specifies the cryptographic
nonce
string. - secret
Key String - Specifies the shared secret key.
- signed
Header String - Specifies the name of the header containing encrypted request data.
- template
Uuid String - This option is for internal usage only.
- use
Custom BooleanSign String - 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. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Sign string[]Strings - Specifies the set of data to be encrypted as a combination of concatenated strings.
- data
Header string - Specifies the name of the header that contains the request data that needs to be encrypted.
- enabled boolean
- Enables the g2o verification behavior.
- encoding
Version number - Specifies the version of the encryption algorithm as an integer from
1
through5
. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- nonce string
- Specifies the cryptographic
nonce
string. - secret
Key string - Specifies the shared secret key.
- signed
Header string - Specifies the name of the header containing encrypted request data.
- template
Uuid string - This option is for internal usage only.
- use
Custom booleanSign String - 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. - uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom_
sign_ Sequence[str]strings - Specifies the set of data to be encrypted as a combination of concatenated strings.
- data_
header str - Specifies the name of the header that contains the request data that needs to be encrypted.
- enabled bool
- Enables the g2o verification behavior.
- encoding_
version int - Specifies the version of the encryption algorithm as an integer from
1
through5
. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- nonce str
- Specifies the cryptographic
nonce
string. - secret_
key str - Specifies the shared secret key.
- signed_
header str - Specifies the name of the header containing encrypted request data.
- template_
uuid str - This option is for internal usage only.
- use_
custom_ boolsign_ string - 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. - uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Sign List<String>Strings - Specifies the set of data to be encrypted as a combination of concatenated strings.
- data
Header String - Specifies the name of the header that contains the request data that needs to be encrypted.
- enabled Boolean
- Enables the g2o verification behavior.
- encoding
Version Number - Specifies the version of the encryption algorithm as an integer from
1
through5
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- nonce String
- Specifies the cryptographic
nonce
string. - secret
Key String - Specifies the shared secret key.
- signed
Header String - Specifies the name of the header containing encrypted request data.
- template
Uuid String - This option is for internal usage only.
- use
Custom BooleanSign String - 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. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorGlobalRequestNumber
- Header
Name string - With
outputOption
set to specify any set of headers, this specifies the name of the header to report the GRN value. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Output
Option string - Specifies how to report the GRN value.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Variable
Name string - 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.
- Header
Name string - With
outputOption
set to specify any set of headers, this specifies the name of the header to report the GRN value. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Output
Option string - Specifies how to report the GRN value.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Variable
Name string - 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.
- header
Name String - With
outputOption
set to specify any set of headers, this specifies the name of the header to report the GRN value. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- output
Option String - Specifies how to report the GRN value.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- variable
Name String - 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.
- header
Name string - With
outputOption
set to specify any set of headers, this specifies the name of the header to report the GRN value. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- output
Option string - Specifies how to report the GRN value.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- variable
Name string - 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.
- header_
name str - With
outputOption
set to specify any set of headers, this specifies the name of the header to report the GRN value. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- output_
option str - Specifies how to report the GRN value.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- variable_
name str - 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.
- header
Name String - With
outputOption
set to specify any set of headers, this specifies the name of the header to report the GRN value. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- output
Option String - Specifies how to report the GRN value.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- variable
Name String - 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.
GetPropertyRulesBuilderRulesV20230105BehaviorGraphqlCaching
- Advanced string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cache
Responses boolWith Errors - When enabled, caches responses that include an
error
field at the top of the response body object. Disable this if your GraphQL server yields temporary errors with success codes in the 2xx range. - Enabled bool
- Enables GraphQL caching.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Operations
Json stringBody Parameter Name - The name of the JSON body parameter that identifies GraphQL POST requests.
- Operations
Url stringQuery Parameter Name - Specifies the name of a query parameter that identifies requests as GraphQL queries.
- Post
Request stringProcessing Error Handling - Specify what happens if GraphQL query processing fails on POST requests.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Advanced string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cache
Responses boolWith Errors - When enabled, caches responses that include an
error
field at the top of the response body object. Disable this if your GraphQL server yields temporary errors with success codes in the 2xx range. - Enabled bool
- Enables GraphQL caching.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Operations
Json stringBody Parameter Name - The name of the JSON body parameter that identifies GraphQL POST requests.
- Operations
Url stringQuery Parameter Name - Specifies the name of a query parameter that identifies requests as GraphQL queries.
- Post
Request stringProcessing Error Handling - Specify what happens if GraphQL query processing fails on POST requests.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cache
Responses BooleanWith Errors - When enabled, caches responses that include an
error
field at the top of the response body object. Disable this if your GraphQL server yields temporary errors with success codes in the 2xx range. - enabled Boolean
- Enables GraphQL caching.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- operations
Json StringBody Parameter Name - The name of the JSON body parameter that identifies GraphQL POST requests.
- operations
Url StringQuery Parameter Name - Specifies the name of a query parameter that identifies requests as GraphQL queries.
- post
Request StringProcessing Error Handling - Specify what happens if GraphQL query processing fails on POST requests.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cache
Responses booleanWith Errors - When enabled, caches responses that include an
error
field at the top of the response body object. Disable this if your GraphQL server yields temporary errors with success codes in the 2xx range. - enabled boolean
- Enables GraphQL caching.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- operations
Json stringBody Parameter Name - The name of the JSON body parameter that identifies GraphQL POST requests.
- operations
Url stringQuery Parameter Name - Specifies the name of a query parameter that identifies requests as GraphQL queries.
- post
Request stringProcessing Error Handling - Specify what happens if GraphQL query processing fails on POST requests.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cache_
responses_ boolwith_ errors - When enabled, caches responses that include an
error
field at the top of the response body object. Disable this if your GraphQL server yields temporary errors with success codes in the 2xx range. - enabled bool
- Enables GraphQL caching.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- operations_
json_ strbody_ parameter_ name - The name of the JSON body parameter that identifies GraphQL POST requests.
- operations_
url_ strquery_ parameter_ name - Specifies the name of a query parameter that identifies requests as GraphQL queries.
- post_
request_ strprocessing_ error_ handling - Specify what happens if GraphQL query processing fails on POST requests.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cache
Responses BooleanWith Errors - When enabled, caches responses that include an
error
field at the top of the response body object. Disable this if your GraphQL server yields temporary errors with success codes in the 2xx range. - enabled Boolean
- Enables GraphQL caching.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- operations
Json StringBody Parameter Name - The name of the JSON body parameter that identifies GraphQL POST requests.
- operations
Url StringQuery Parameter Name - Specifies the name of a query parameter that identifies requests as GraphQL queries.
- post
Request StringProcessing Error Handling - Specify what happens if GraphQL query processing fails on POST requests.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorGzipResponse
- Behavior string
- Specify when to compress responses.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Behavior string
- Specify when to compress responses.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior String
- Specify when to compress responses.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior string
- Specify when to compress responses.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior str
- Specify when to compress responses.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- behavior String
- Specify when to compress responses.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorHdDataAdvanced
- Description string
- Human-readable description of what the XML block does.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Xml string
- A block of Akamai XML metadata.
- Description string
- Human-readable description of what the XML block does.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Xml string
- A block of Akamai XML metadata.
- description String
- Human-readable description of what the XML block does.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml String
- A block of Akamai XML metadata.
- description string
- Human-readable description of what the XML block does.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml string
- A block of Akamai XML metadata.
- description str
- Human-readable description of what the XML block does.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml str
- A block of Akamai XML metadata.
- description String
- Human-readable description of what the XML block does.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- xml String
- A block of Akamai XML metadata.
GetPropertyRulesBuilderRulesV20230105BehaviorHealthDetection
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Maximum
Reconnects int - 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 ofretryCount
. - Retry
Count int - The number of consecutive connection failures that mark an IP address as faulty.
- Retry
Interval 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.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Maximum
Reconnects int - 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 ofretryCount
. - Retry
Count int - The number of consecutive connection failures that mark an IP address as faulty.
- Retry
Interval 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.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- maximum
Reconnects Integer - 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 ofretryCount
. - retry
Count Integer - The number of consecutive connection failures that mark an IP address as faulty.
- retry
Interval 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.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- maximum
Reconnects 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 ofretryCount
. - retry
Count number - The number of consecutive connection failures that mark an IP address as faulty.
- retry
Interval 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.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- maximum_
reconnects int - 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 ofretryCount
. - retry_
count int - The number of consecutive connection failures that mark an IP address as faulty.
- retry_
interval str - Specifies the amount of time the edge server will wait before trying to reconnect to an IP address it has already identified as faulty.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- maximum
Reconnects 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 ofretryCount
. - retry
Count Number - The number of consecutive connection failures that mark an IP address as faulty.
- retry
Interval 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.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorHsafEipBinding
- Custom
Extracted boolSerial - Whether to pull the serial number from the variable value set in the
advanced
behavior. Work with your Akamai Services team to add theadvanced
behavior earlier in your property to extract and apply theAKA_PM_EIP_HSAF_SERIAL
variable. - Enabled bool
- Enables HSAF for Edge IP Binding customers with a large footprint.
- Hash
Max intValue - Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than
hashMinValue
. - Hash
Min intValue - Specifies the minimum value for the HSAF hash range, from 2 through 2045. This needs to be lower than
hashMaxValue
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Tier string
- Specifies where the behavior is applied.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Custom
Extracted boolSerial - Whether to pull the serial number from the variable value set in the
advanced
behavior. Work with your Akamai Services team to add theadvanced
behavior earlier in your property to extract and apply theAKA_PM_EIP_HSAF_SERIAL
variable. - Enabled bool
- Enables HSAF for Edge IP Binding customers with a large footprint.
- Hash
Max intValue - Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than
hashMinValue
. - Hash
Min intValue - Specifies the minimum value for the HSAF hash range, from 2 through 2045. This needs to be lower than
hashMaxValue
. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Tier string
- Specifies where the behavior is applied.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Extracted BooleanSerial - Whether to pull the serial number from the variable value set in the
advanced
behavior. Work with your Akamai Services team to add theadvanced
behavior earlier in your property to extract and apply theAKA_PM_EIP_HSAF_SERIAL
variable. - enabled Boolean
- Enables HSAF for Edge IP Binding customers with a large footprint.
- hash
Max IntegerValue - Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than
hashMinValue
. - hash
Min IntegerValue - Specifies the minimum value for the HSAF hash range, from 2 through 2045. This needs to be lower than
hashMaxValue
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- tier String
- Specifies where the behavior is applied.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Extracted booleanSerial - Whether to pull the serial number from the variable value set in the
advanced
behavior. Work with your Akamai Services team to add theadvanced
behavior earlier in your property to extract and apply theAKA_PM_EIP_HSAF_SERIAL
variable. - enabled boolean
- Enables HSAF for Edge IP Binding customers with a large footprint.
- hash
Max numberValue - Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than
hashMinValue
. - hash
Min numberValue - Specifies the minimum value for the HSAF hash range, from 2 through 2045. This needs to be lower than
hashMaxValue
. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- tier string
- Specifies where the behavior is applied.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom_
extracted_ boolserial - Whether to pull the serial number from the variable value set in the
advanced
behavior. Work with your Akamai Services team to add theadvanced
behavior earlier in your property to extract and apply theAKA_PM_EIP_HSAF_SERIAL
variable. - enabled bool
- Enables HSAF for Edge IP Binding customers with a large footprint.
- hash_
max_ intvalue - Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than
hashMinValue
. - hash_
min_ intvalue - Specifies the minimum value for the HSAF hash range, from 2 through 2045. This needs to be lower than
hashMaxValue
. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- tier str
- Specifies where the behavior is applied.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Extracted BooleanSerial - Whether to pull the serial number from the variable value set in the
advanced
behavior. Work with your Akamai Services team to add theadvanced
behavior earlier in your property to extract and apply theAKA_PM_EIP_HSAF_SERIAL
variable. - enabled Boolean
- Enables HSAF for Edge IP Binding customers with a large footprint.
- hash
Max NumberValue - Specifies the maximum value for the hash range, from 3 through 2046. This needs to be higher than
hashMinValue
. - hash
Min NumberValue - Specifies the minimum value for the HSAF hash range, from 2 through 2045. This needs to be lower than
hashMaxValue
. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- tier String
- Specifies where the behavior is applied.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorHttp2
- Enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorHttp3
- Enable bool
- This enables HTTP/3 connections between requesting clients and Akamai edge servers. You also need to enable QUIC and TLS 1.3 in your certificate deployment settings. See the
Property Manager documentation
for more details. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enable bool
- This enables HTTP/3 connections between requesting clients and Akamai edge servers. You also need to enable QUIC and TLS 1.3 in your certificate deployment settings. See the
Property Manager documentation
for more details. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable Boolean
- This enables HTTP/3 connections between requesting clients and Akamai edge servers. You also need to enable QUIC and TLS 1.3 in your certificate deployment settings. See the
Property Manager documentation
for more details. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable boolean
- This enables HTTP/3 connections between requesting clients and Akamai edge servers. You also need to enable QUIC and TLS 1.3 in your certificate deployment settings. See the
Property Manager documentation
for more details. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable bool
- This enables HTTP/3 connections between requesting clients and Akamai edge servers. You also need to enable QUIC and TLS 1.3 in your certificate deployment settings. See the
Property Manager documentation
for more details. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable Boolean
- This enables HTTP/3 connections between requesting clients and Akamai edge servers. You also need to enable QUIC and TLS 1.3 in your certificate deployment settings. See the
Property Manager documentation
for more details. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorHttpStrictTransportSecurity
- Enable bool
- Applies HSTS to this set of requests.
- Include
Sub boolDomains - When enabled, applies HSTS to all subdomains.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Max
Age string - Specifies the duration for which to apply HSTS for new browser connections.
- Preload bool
- When enabled, adds this domain to the browser's preload list. You still need to declare the domain at
hstspreload.org
. - Redirect bool
- When enabled, redirects all HTTP requests to HTTPS.
- Redirect
Status intCode - Specifies a response code.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enable bool
- Applies HSTS to this set of requests.
- Include
Sub boolDomains - When enabled, applies HSTS to all subdomains.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Max
Age string - Specifies the duration for which to apply HSTS for new browser connections.
- Preload bool
- When enabled, adds this domain to the browser's preload list. You still need to declare the domain at
hstspreload.org
. - Redirect bool
- When enabled, redirects all HTTP requests to HTTPS.
- Redirect
Status intCode - Specifies a response code.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable Boolean
- Applies HSTS to this set of requests.
- include
Sub BooleanDomains - When enabled, applies HSTS to all subdomains.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- max
Age String - Specifies the duration for which to apply HSTS for new browser connections.
- 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.
- redirect
Status IntegerCode - Specifies a response code.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable boolean
- Applies HSTS to this set of requests.
- include
Sub booleanDomains - When enabled, applies HSTS to all subdomains.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- max
Age string - Specifies the duration for which to apply HSTS for new browser connections.
- 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.
- redirect
Status numberCode - Specifies a response code.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable bool
- Applies HSTS to this set of requests.
- include_
sub_ booldomains - When enabled, applies HSTS to all subdomains.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- max_
age str - Specifies the duration for which to apply HSTS for new browser connections.
- preload bool
- When enabled, adds this domain to the browser's preload list. You still need to declare the domain at
hstspreload.org
. - redirect bool
- When enabled, redirects all HTTP requests to HTTPS.
- redirect_
status_ intcode - Specifies a response code.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable Boolean
- Applies HSTS to this set of requests.
- include
Sub BooleanDomains - When enabled, applies HSTS to all subdomains.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- max
Age String - Specifies the duration for which to apply HSTS for new browser connections.
- 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.
- redirect
Status NumberCode - Specifies a response code.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorHttpToHttpsUpgrade
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Upgrade string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Upgrade string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- upgrade String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- upgrade string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- upgrade str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- upgrade String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorImOverride
- Dpr double
- Directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.
- Dprvar string
- This selects the variable with the desired pixel density. The variable specifies the same type of data as the
dpr
option below. - Exclude
All boolQuery Parameters - Whether to exclude all query parameters from the Image and Video Manager cache key.
- Excluded
Query List<string>Parameters - Specifies individual query parameters to exclude from the Image and Video Manager cache key.
- Format string
- Specifies the type of the browser, or the encodings passed in the
Accept
header, that you want to optimize images for. - Formatvar string
- 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. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Override string
- Selects the type of query parameter you want to set.
- Policy string
- 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.
- Policyvar string
- 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.
- Policyvar
IMvar string - This selects one of the property's rule tree variables to assign to the
policyvarName
variable within Image and Video Manager. - Policyvar
Name string - 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.
- Template
Uuid string - This option is for internal usage only.
- Typesel string
- Specifies how to set a query parameter.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Width double
- Sets the image's desired pixel width directly. If the Image Manager policy doesn't define that width, it serves the next largest width.
- Widthvar string
- 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.
- Dpr float64
- Directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.
- Dprvar string
- This selects the variable with the desired pixel density. The variable specifies the same type of data as the
dpr
option below. - Exclude
All boolQuery Parameters - Whether to exclude all query parameters from the Image and Video Manager cache key.
- Excluded
Query []stringParameters - Specifies individual query parameters to exclude from the Image and Video Manager cache key.
- Format string
- Specifies the type of the browser, or the encodings passed in the
Accept
header, that you want to optimize images for. - Formatvar string
- 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. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Override string
- Selects the type of query parameter you want to set.
- Policy string
- 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.
- Policyvar string
- 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.
- Policyvar
IMvar string - This selects one of the property's rule tree variables to assign to the
policyvarName
variable within Image and Video Manager. - Policyvar
Name string - 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.
- Template
Uuid string - This option is for internal usage only.
- Typesel string
- Specifies how to set a query parameter.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Width float64
- Sets the image's desired pixel width directly. If the Image Manager policy doesn't define that width, it serves the next largest width.
- Widthvar string
- 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.
- dpr Double
- Directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.
- dprvar String
- This selects the variable with the desired pixel density. The variable specifies the same type of data as the
dpr
option below. - exclude
All BooleanQuery Parameters - Whether to exclude all query parameters from the Image and Video Manager cache key.
- excluded
Query List<String>Parameters - Specifies individual query parameters to exclude from the Image and Video Manager cache key.
- format String
- Specifies the type of the browser, or the encodings passed in the
Accept
header, that you want to optimize images for. - formatvar String
- 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. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override String
- Selects the type of query parameter you want to set.
- policy String
- 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.
- policyvar String
- 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.
- policyvar
IMvar String - This selects one of the property's rule tree variables to assign to the
policyvarName
variable within Image and Video Manager. - policyvar
Name String - 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.
- template
Uuid String - This option is for internal usage only.
- typesel String
- Specifies how to set a query parameter.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- width Double
- Sets the image's desired pixel width directly. If the Image Manager policy doesn't define that width, it serves the next largest width.
- widthvar String
- 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.
- dpr number
- Directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.
- dprvar string
- This selects the variable with the desired pixel density. The variable specifies the same type of data as the
dpr
option below. - exclude
All booleanQuery Parameters - Whether to exclude all query parameters from the Image and Video Manager cache key.
- excluded
Query string[]Parameters - Specifies individual query parameters to exclude from the Image and Video Manager cache key.
- format string
- Specifies the type of the browser, or the encodings passed in the
Accept
header, that you want to optimize images for. - formatvar string
- 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. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override string
- Selects the type of query parameter you want to set.
- policy string
- 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.
- policyvar string
- 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.
- policyvar
IMvar string - This selects one of the property's rule tree variables to assign to the
policyvarName
variable within Image and Video Manager. - policyvar
Name string - 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.
- template
Uuid string - This option is for internal usage only.
- typesel string
- Specifies how to set a query parameter.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- width number
- Sets the image's desired pixel width directly. If the Image Manager policy doesn't define that width, it serves the next largest width.
- widthvar string
- 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.
- dpr float
- Directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.
- dprvar str
- This selects the variable with the desired pixel density. The variable specifies the same type of data as the
dpr
option below. - exclude_
all_ boolquery_ parameters - Whether to exclude all query parameters from the Image and Video Manager cache key.
- excluded_
query_ Sequence[str]parameters - Specifies individual query parameters to exclude from the Image and Video Manager cache key.
- format str
- Specifies the type of the browser, or the encodings passed in the
Accept
header, that you want to optimize images for. - formatvar str
- 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. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override str
- Selects the type of query parameter you want to set.
- policy str
- 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.
- policyvar str
- 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.
- policyvar_
i_ strmvar - This selects one of the property's rule tree variables to assign to the
policyvarName
variable within Image and Video Manager. - policyvar_
name str - 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.
- template_
uuid str - This option is for internal usage only.
- typesel str
- Specifies how to set a query parameter.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- width float
- Sets the image's desired pixel width directly. If the Image Manager policy doesn't define that width, it serves the next largest width.
- widthvar str
- 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.
- dpr Number
- Directly specifies the pixel density. The numeric value is a scaling factor of 1, representing normal density.
- dprvar String
- This selects the variable with the desired pixel density. The variable specifies the same type of data as the
dpr
option below. - exclude
All BooleanQuery Parameters - Whether to exclude all query parameters from the Image and Video Manager cache key.
- excluded
Query List<String>Parameters - Specifies individual query parameters to exclude from the Image and Video Manager cache key.
- format String
- Specifies the type of the browser, or the encodings passed in the
Accept
header, that you want to optimize images for. - formatvar String
- 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. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- override String
- Selects the type of query parameter you want to set.
- policy String
- 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.
- policyvar String
- 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.
- policyvar
IMvar String - This selects one of the property's rule tree variables to assign to the
policyvarName
variable within Image and Video Manager. - policyvar
Name String - 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.
- template
Uuid String - This option is for internal usage only.
- typesel String
- Specifies how to set a query parameter.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- width Number
- Sets the image's desired pixel width directly. If the Image Manager policy doesn't define that width, it serves the next largest width.
- widthvar String
- 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.
GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManager
- Apply
Best boolFile Type - Cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original - Cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed - Enabled bool
- Image
Set string - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Policy
Set stringType - Resize bool
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Video
Set string
- Apply
Best boolFile Type - Cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original - Cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed - Enabled bool
- Image
Set string - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Policy
Set stringType - Resize bool
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Video
Set string
- apply
Best BooleanFile Type - cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original - cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed - enabled Boolean
- image
Set String - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set StringType - resize Boolean
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- video
Set String
- apply
Best booleanFile Type - cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original - cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed - enabled boolean
- image
Set string - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set stringType - resize boolean
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- video
Set string
- apply_
best_ boolfile_ type - cp_
code_ Getoriginal Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original - cp_
code_ Gettransformed Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed - enabled bool
- image_
set str - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy_
set_ strtype - resize bool
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- video_
set str
- apply
Best BooleanFile Type - cp
Code Property MapOriginal - cp
Code Property MapTransformed - enabled Boolean
- image
Set String - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set StringType - resize Boolean
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- video
Set String
GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginal
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeOriginalCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformed
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Image And Video Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageAndVideoManagerCpCodeTransformedCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManager
- Advanced bool
- Generates 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 (thepolicyToken
) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property. - Api
Reference stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Apply
Best boolFile Type - 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.
- Cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original - Assigns a CP code to track traffic and billing for original images that the Image and Video Manager has not modified. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed - Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Enabled bool
- Enable image management capabilities and generate a corresponding API token.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Policy
Set string - Identifies the existing policy set configured with
Image and Video Manager API
. - Policy
Token string - 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. - Policy
Token stringDefault - Specify the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. Theadvanced
option needs to be inactive. - Resize bool
- 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.
- Settings
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Super
Cache stringRegion - Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
- Template
Uuid string - This option is for internal usage only.
- Traffic
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Use
Existing boolPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Advanced bool
- Generates 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 (thepolicyToken
) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property. - Api
Reference stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Apply
Best boolFile Type - 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.
- Cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original - Assigns a CP code to track traffic and billing for original images that the Image and Video Manager has not modified. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed - Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Enabled bool
- Enable image management capabilities and generate a corresponding API token.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Policy
Set string - Identifies the existing policy set configured with
Image and Video Manager API
. - Policy
Token string - 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. - Policy
Token stringDefault - Specify the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. Theadvanced
option needs to be inactive. - Resize bool
- 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.
- Settings
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Super
Cache stringRegion - Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
- Template
Uuid string - This option is for internal usage only.
- Traffic
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Use
Existing boolPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced Boolean
- Generates 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 (thepolicyToken
) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property. - api
Reference StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- apply
Best BooleanFile Type - 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.
- cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original - Assigns a CP code to track traffic and billing for original images that the Image and Video Manager has not modified. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed - Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - enabled Boolean
- Enable image management capabilities and generate a corresponding API token.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set String - Identifies the existing policy set configured with
Image and Video Manager API
. - policy
Token String - 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. - policy
Token StringDefault - Specify the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. Theadvanced
option needs to be inactive. - 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.
- settings
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- super
Cache StringRegion - Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
- template
Uuid String - This option is for internal usage only.
- traffic
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- use
Existing BooleanPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced boolean
- Generates 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 (thepolicyToken
) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property. - api
Reference stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- apply
Best booleanFile Type - 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.
- cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original - Assigns a CP code to track traffic and billing for original images that the Image and Video Manager has not modified. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed - Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - enabled boolean
- Enable image management capabilities and generate a corresponding API token.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set string - Identifies the existing policy set configured with
Image and Video Manager API
. - policy
Token string - 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. - policy
Token stringDefault - Specify the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. Theadvanced
option needs to be inactive. - 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.
- settings
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- super
Cache stringRegion - Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
- template
Uuid string - This option is for internal usage only.
- traffic
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- use
Existing booleanPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced bool
- Generates 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 (thepolicyToken
) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property. - api_
reference_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- apply_
best_ boolfile_ type - 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.
- cp_
code_ Getoriginal Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original - Assigns a CP code to track traffic and billing for original images that the Image and Video Manager has not modified. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - cp_
code_ Gettransformed Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed - Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - enabled bool
- Enable image management capabilities and generate a corresponding API token.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy_
set str - Identifies the existing policy set configured with
Image and Video Manager API
. - policy_
token str - 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. - policy_
token_ strdefault - Specify the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. Theadvanced
option needs to be inactive. - resize bool
- 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.
- settings_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- super_
cache_ strregion - Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
- template_
uuid str - This option is for internal usage only.
- traffic_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- use_
existing_ boolpolicy_ set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced Boolean
- Generates 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 (thepolicyToken
) concatenated with a property-specific identifier that's generated when you save the property. The API registers the token when you activate the property. - api
Reference StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- apply
Best BooleanFile Type - 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.
- cp
Code Property MapOriginal - Assigns a CP code to track traffic and billing for original images that the Image and Video Manager has not modified. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - cp
Code Property MapTransformed - Assigns a separate CP code to track traffic and billing for derived images. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - enabled Boolean
- Enable image management capabilities and generate a corresponding API token.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set String - Identifies the existing policy set configured with
Image and Video Manager API
. - policy
Token String - 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. - policy
Token StringDefault - Specify the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. Theadvanced
option needs to be inactive. - 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.
- settings
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- super
Cache StringRegion - Specifies a location for your site's heaviest traffic, for use in caching derivatives on edge servers.
- template
Uuid String - This option is for internal usage only.
- traffic
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- use
Existing BooleanPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginal
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeOriginalCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformed
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Image Manager Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerCpCodeTransformedCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideo
- Advanced bool
- When disabled, applies a single standard policy based on your property name. Allows you to reference a rule-specific
policyToken
for videos with different match criteria. - Api
Reference stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Apply
Best boolFile Type - 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.
- Cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original - Specifies 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. You only need to provide the initialid
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed - Specifies the CP code to identify derivative transformed video content. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Enabled bool
- Applies Image and Video Manager's video optimization to the current content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Policy
Set string - Identifies the existing policy set configured with
Image and Video Manager API
. - Policy
Token string - 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. - Policy
Token stringDefault - Specifies the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. - Resize bool
- When enabled, scales down video for smaller mobile screens, based on the device's
User-Agent
header. - Settings
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Super
Cache stringRegion - To optimize caching, assign a region close to your site's heaviest traffic.
- Template
Uuid string - This option is for internal usage only.
- Traffic
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Use
Existing boolPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Advanced bool
- When disabled, applies a single standard policy based on your property name. Allows you to reference a rule-specific
policyToken
for videos with different match criteria. - Api
Reference stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Apply
Best boolFile Type - 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.
- Cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original - Specifies 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. You only need to provide the initialid
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed - Specifies the CP code to identify derivative transformed video content. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - Enabled bool
- Applies Image and Video Manager's video optimization to the current content.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Policy
Set string - Identifies the existing policy set configured with
Image and Video Manager API
. - Policy
Token string - 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. - Policy
Token stringDefault - Specifies the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. - Resize bool
- When enabled, scales down video for smaller mobile screens, based on the device's
User-Agent
header. - Settings
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Super
Cache stringRegion - To optimize caching, assign a region close to your site's heaviest traffic.
- Template
Uuid string - This option is for internal usage only.
- Traffic
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Use
Existing boolPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced Boolean
- When disabled, applies a single standard policy based on your property name. Allows you to reference a rule-specific
policyToken
for videos with different match criteria. - api
Reference StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- apply
Best BooleanFile Type - 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.
- cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original - Specifies 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. You only need to provide the initialid
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed - Specifies the CP code to identify derivative transformed video content. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - enabled Boolean
- Applies Image and Video Manager's video optimization to the current content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set String - Identifies the existing policy set configured with
Image and Video Manager API
. - policy
Token String - 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. - policy
Token StringDefault - Specifies the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. - resize Boolean
- When enabled, scales down video for smaller mobile screens, based on the device's
User-Agent
header. - settings
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- super
Cache StringRegion - To optimize caching, assign a region close to your site's heaviest traffic.
- template
Uuid String - This option is for internal usage only.
- traffic
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- use
Existing BooleanPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced boolean
- When disabled, applies a single standard policy based on your property name. Allows you to reference a rule-specific
policyToken
for videos with different match criteria. - api
Reference stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- apply
Best booleanFile Type - 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.
- cp
Code GetOriginal Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original - Specifies 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. You only need to provide the initialid
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - cp
Code GetTransformed Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed - Specifies the CP code to identify derivative transformed video content. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - enabled boolean
- Applies Image and Video Manager's video optimization to the current content.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set string - Identifies the existing policy set configured with
Image and Video Manager API
. - policy
Token string - 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. - policy
Token stringDefault - Specifies the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. - resize boolean
- When enabled, scales down video for smaller mobile screens, based on the device's
User-Agent
header. - settings
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- super
Cache stringRegion - To optimize caching, assign a region close to your site's heaviest traffic.
- template
Uuid string - This option is for internal usage only.
- traffic
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- use
Existing booleanPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced bool
- When disabled, applies a single standard policy based on your property name. Allows you to reference a rule-specific
policyToken
for videos with different match criteria. - api_
reference_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- apply_
best_ boolfile_ type - 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.
- cp_
code_ Getoriginal Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original - Specifies 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. You only need to provide the initialid
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - cp_
code_ Gettransformed Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed - Specifies the CP code to identify derivative transformed video content. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - enabled bool
- Applies Image and Video Manager's video optimization to the current content.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy_
set str - Identifies the existing policy set configured with
Image and Video Manager API
. - policy_
token str - 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. - policy_
token_ strdefault - Specifies the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. - resize bool
- When enabled, scales down video for smaller mobile screens, based on the device's
User-Agent
header. - settings_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- super_
cache_ strregion - To optimize caching, assign a region close to your site's heaviest traffic.
- template_
uuid str - This option is for internal usage only.
- traffic_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- use_
existing_ boolpolicy_ set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- advanced Boolean
- When disabled, applies a single standard policy based on your property name. Allows you to reference a rule-specific
policyToken
for videos with different match criteria. - api
Reference StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- apply
Best BooleanFile Type - 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.
- cp
Code Property MapOriginal - Specifies 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. You only need to provide the initialid
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - cp
Code Property MapTransformed - Specifies the CP code to identify derivative transformed video content. You only need to provide the initial
id
, stripping anycpc_
prefix to pass the integer to the rule tree. Additional CP code details may reflect back in subsequent read-only data. - enabled Boolean
- Applies Image and Video Manager's video optimization to the current content.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- policy
Set String - Identifies the existing policy set configured with
Image and Video Manager API
. - policy
Token String - 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. - policy
Token StringDefault - Specifies the default policy identifier, which is registered with the
Image and Video Manager API
once you activate this property. - resize Boolean
- When enabled, scales down video for smaller mobile screens, based on the device's
User-Agent
header. - settings
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- super
Cache StringRegion - To optimize caching, assign a region close to your site's heaviest traffic.
- template
Uuid String - This option is for internal usage only.
- traffic
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- use
Existing BooleanPolicy Set - Whether to use a previously created policy set that may be referenced in other properties, or create a new policy set to use with this property. A policy set can be shared across multiple properties belonging to the same contract. The behavior populates any changes to the policy set across all properties that reference that set.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginal
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Original Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeOriginalCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformed
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products List<string>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Created
Date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Id int
- Name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Products []string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Integer
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code GetLimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id number
- name string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products string[]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp_
code_ Getlimits Property Rules Builder Rules V20230105Behavior Image Manager Video Cp Code Transformed Cp Code Limits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created_
date int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id int
- name str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products Sequence[str]
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- cp
Code Property MapLimits - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- created
Date Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- description String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- id Number
- name String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- products List<String>
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorImageManagerVideoCpCodeTransformedCpCodeLimits
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Current
Capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Integer - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Integer
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current_
capacity int - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit int
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit_
type str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- current
Capacity Number - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit Number
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- limit
Type String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorInclude
- Id string
- Identifies the include you want to add to your rule tree. You can get the include ID using
PAPI
. This option only accepts digits, without theinc_
ID prefix. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Id string
- Identifies the include you want to add to your rule tree. You can get the include ID using
PAPI
. This option only accepts digits, without theinc_
ID prefix. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- id String
- Identifies the include you want to add to your rule tree. You can get the include ID using
PAPI
. This option only accepts digits, without theinc_
ID prefix. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- id string
- Identifies the include you want to add to your rule tree. You can get the include ID using
PAPI
. This option only accepts digits, without theinc_
ID prefix. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- id str
- Identifies the include you want to add to your rule tree. You can get the include ID using
PAPI
. This option only accepts digits, without theinc_
ID prefix. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- id String
- Identifies the include you want to add to your rule tree. You can get the include ID using
PAPI
. This option only accepts digits, without theinc_
ID prefix. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorInputValidation
- Allow
Large boolPost Body - Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Input Validation Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Applies the Input Validation Cloudlet behavior.
- Failure302Uri string
- Specifies the redirect link for invalid requests that have not yet triggered a penalty.
- Label string
- Distinguishes this Input Validation policy from any others within the same property.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Penalty302Uri string
- Specifies the redirect link for end users who trigger the penalty.
- Penalty403Net
Storage stringPath - Specifies the full path to the static 403 response content relative to the
downloadDomainName
in thepenaltyNetStorage
object. - Penalty
Action string - Once the
penaltyThreshold
of invalid requests is met, this specifies the response. - Penalty
Branded intDeny Cache Ttl - Specifies the penalty response's time to live in the cache,
5
minutes by default. - Penalty
Net GetStorage Property Rules Builder Rules V20230105Behavior Input Validation Penalty Net Storage - 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 integercpCode
to track the traffic. - Penalty
Threshold int - Specifies the number of invalid requests permitted before executing the
penaltyAction
. - Penalty
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Reset
On boolValid - 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 thepenaltyAction
. - Template
Uuid string - This option is for internal usage only.
- bool
- When enabled, identifies users by the value of a cookie.
- User
Identification boolBy Headers - When enabled, identifies users by specific HTTP headers on GET or POST requests.
- User
Identification boolBy Ip - When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
- User
Identification boolBy Params - When enabled, identifies users by specific query parameters on GET or POST requests.
- string
- This specifies the cookie name whose value needs to remain constant across requests to identify a user.
- User
Identification List<string>Key Headers - This specifies the HTTP headers whose combined set of values identify each end user.
- User
Identification List<string>Key Params - This specifies the query parameters whose combined set of values identify each end user.
- User
Identification stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Validate
On stringOrigin Header Name - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies the header name for a request that the origin identifies as invalid. - Validate
On stringOrigin Header Value - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies an invalid request's header value that corresponds to thevalidateOnOriginHeaderName
. - Validate
On intOrigin Response Code - Unless
validateOnOriginWith
isDISABLED
, this identifies the integer response code for requests the origin identifies as invalid. - Validate
On stringOrigin With - 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.
- Validation
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Allow
Large boolPost Body - Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Input Validation Cloudlet Policy - Identifies the Cloudlet policy.
- Enabled bool
- Applies the Input Validation Cloudlet behavior.
- Failure302Uri string
- Specifies the redirect link for invalid requests that have not yet triggered a penalty.
- Label string
- Distinguishes this Input Validation policy from any others within the same property.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Penalty302Uri string
- Specifies the redirect link for end users who trigger the penalty.
- Penalty403Net
Storage stringPath - Specifies the full path to the static 403 response content relative to the
downloadDomainName
in thepenaltyNetStorage
object. - Penalty
Action string - Once the
penaltyThreshold
of invalid requests is met, this specifies the response. - Penalty
Branded intDeny Cache Ttl - Specifies the penalty response's time to live in the cache,
5
minutes by default. - Penalty
Net GetStorage Property Rules Builder Rules V20230105Behavior Input Validation Penalty Net Storage - 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 integercpCode
to track the traffic. - Penalty
Threshold int - Specifies the number of invalid requests permitted before executing the
penaltyAction
. - Penalty
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Reset
On boolValid - 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 thepenaltyAction
. - Template
Uuid string - This option is for internal usage only.
- bool
- When enabled, identifies users by the value of a cookie.
- User
Identification boolBy Headers - When enabled, identifies users by specific HTTP headers on GET or POST requests.
- User
Identification boolBy Ip - When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
- User
Identification boolBy Params - When enabled, identifies users by specific query parameters on GET or POST requests.
- string
- This specifies the cookie name whose value needs to remain constant across requests to identify a user.
- User
Identification []stringKey Headers - This specifies the HTTP headers whose combined set of values identify each end user.
- User
Identification []stringKey Params - This specifies the query parameters whose combined set of values identify each end user.
- User
Identification stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Validate
On stringOrigin Header Name - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies the header name for a request that the origin identifies as invalid. - Validate
On stringOrigin Header Value - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies an invalid request's header value that corresponds to thevalidateOnOriginHeaderName
. - Validate
On intOrigin Response Code - Unless
validateOnOriginWith
isDISABLED
, this identifies the integer response code for requests the origin identifies as invalid. - Validate
On stringOrigin With - 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.
- Validation
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- allow
Large BooleanPost Body - Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Input Validation Cloudlet Policy - Identifies the Cloudlet policy.
- enabled Boolean
- Applies the Input Validation Cloudlet behavior.
- failure302Uri String
- Specifies the redirect link for invalid requests that have not yet triggered a penalty.
- label String
- Distinguishes this Input Validation policy from any others within the same property.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- penalty302Uri String
- Specifies the redirect link for end users who trigger the penalty.
- penalty403Net
Storage StringPath - Specifies the full path to the static 403 response content relative to the
downloadDomainName
in thepenaltyNetStorage
object. - penalty
Action String - Once the
penaltyThreshold
of invalid requests is met, this specifies the response. - penalty
Branded IntegerDeny Cache Ttl - Specifies the penalty response's time to live in the cache,
5
minutes by default. - penalty
Net GetStorage Property Rules Builder Rules V20230105Behavior Input Validation Penalty Net Storage - 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 integercpCode
to track the traffic. - penalty
Threshold Integer - Specifies the number of invalid requests permitted before executing the
penaltyAction
. - penalty
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- reset
On BooleanValid - 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 thepenaltyAction
. - template
Uuid String - This option is for internal usage only.
- Boolean
- When enabled, identifies users by the value of a cookie.
- user
Identification BooleanBy Headers - When enabled, identifies users by specific HTTP headers on GET or POST requests.
- user
Identification BooleanBy Ip - When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
- user
Identification BooleanBy Params - When enabled, identifies users by specific query parameters on GET or POST requests.
- String
- This specifies the cookie name whose value needs to remain constant across requests to identify a user.
- user
Identification List<String>Key Headers - This specifies the HTTP headers whose combined set of values identify each end user.
- user
Identification List<String>Key Params - This specifies the query parameters whose combined set of values identify each end user.
- user
Identification StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- validate
On StringOrigin Header Name - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies the header name for a request that the origin identifies as invalid. - validate
On StringOrigin Header Value - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies an invalid request's header value that corresponds to thevalidateOnOriginHeaderName
. - validate
On IntegerOrigin Response Code - Unless
validateOnOriginWith
isDISABLED
, this identifies the integer response code for requests the origin identifies as invalid. - validate
On StringOrigin With - 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.
- validation
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- allow
Large booleanPost Body - Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Input Validation Cloudlet Policy - Identifies the Cloudlet policy.
- enabled boolean
- Applies the Input Validation Cloudlet behavior.
- failure302Uri string
- Specifies the redirect link for invalid requests that have not yet triggered a penalty.
- label string
- Distinguishes this Input Validation policy from any others within the same property.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- penalty302Uri string
- Specifies the redirect link for end users who trigger the penalty.
- penalty403Net
Storage stringPath - Specifies the full path to the static 403 response content relative to the
downloadDomainName
in thepenaltyNetStorage
object. - penalty
Action string - Once the
penaltyThreshold
of invalid requests is met, this specifies the response. - penalty
Branded numberDeny Cache Ttl - Specifies the penalty response's time to live in the cache,
5
minutes by default. - penalty
Net GetStorage Property Rules Builder Rules V20230105Behavior Input Validation Penalty Net Storage - 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 integercpCode
to track the traffic. - penalty
Threshold number - Specifies the number of invalid requests permitted before executing the
penaltyAction
. - penalty
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- reset
On booleanValid - 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 thepenaltyAction
. - template
Uuid string - This option is for internal usage only.
- boolean
- When enabled, identifies users by the value of a cookie.
- user
Identification booleanBy Headers - When enabled, identifies users by specific HTTP headers on GET or POST requests.
- user
Identification booleanBy Ip - When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
- user
Identification booleanBy Params - When enabled, identifies users by specific query parameters on GET or POST requests.
- string
- This specifies the cookie name whose value needs to remain constant across requests to identify a user.
- user
Identification string[]Key Headers - This specifies the HTTP headers whose combined set of values identify each end user.
- user
Identification string[]Key Params - This specifies the query parameters whose combined set of values identify each end user.
- user
Identification stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- validate
On stringOrigin Header Name - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies the header name for a request that the origin identifies as invalid. - validate
On stringOrigin Header Value - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies an invalid request's header value that corresponds to thevalidateOnOriginHeaderName
. - validate
On numberOrigin Response Code - Unless
validateOnOriginWith
isDISABLED
, this identifies the integer response code for requests the origin identifies as invalid. - validate
On stringOrigin With - 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.
- validation
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- allow_
large_ boolpost_ body - Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
- cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior Input Validation Cloudlet Policy - Identifies the Cloudlet policy.
- enabled bool
- Applies the Input Validation Cloudlet behavior.
- failure302_
uri str - Specifies the redirect link for invalid requests that have not yet triggered a penalty.
- label str
- Distinguishes this Input Validation policy from any others within the same property.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- penalty302_
uri str - Specifies the redirect link for end users who trigger the penalty.
- penalty403_
net_ strstorage_ path - Specifies the full path to the static 403 response content relative to the
downloadDomainName
in thepenaltyNetStorage
object. - penalty_
action str - Once the
penaltyThreshold
of invalid requests is met, this specifies the response. - penalty_
branded_ intdeny_ cache_ ttl - Specifies the penalty response's time to live in the cache,
5
minutes by default. - penalty_
net_ Getstorage Property Rules Builder Rules V20230105Behavior Input Validation Penalty Net Storage - 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 integercpCode
to track the traffic. - penalty_
threshold int - Specifies the number of invalid requests permitted before executing the
penaltyAction
. - penalty_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- reset_
on_ boolvalid - 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 thepenaltyAction
. - template_
uuid str - This option is for internal usage only.
- bool
- When enabled, identifies users by the value of a cookie.
- user_
identification_ boolby_ headers - When enabled, identifies users by specific HTTP headers on GET or POST requests.
- user_
identification_ boolby_ ip - When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
- user_
identification_ boolby_ params - When enabled, identifies users by specific query parameters on GET or POST requests.
- str
- This specifies the cookie name whose value needs to remain constant across requests to identify a user.
- user_
identification_ Sequence[str]key_ headers - This specifies the HTTP headers whose combined set of values identify each end user.
- user_
identification_ Sequence[str]key_ params - This specifies the query parameters whose combined set of values identify each end user.
- user_
identification_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- validate_
on_ strorigin_ header_ name - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies the header name for a request that the origin identifies as invalid. - validate_
on_ strorigin_ header_ value - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies an invalid request's header value that corresponds to thevalidateOnOriginHeaderName
. - validate_
on_ intorigin_ response_ code - Unless
validateOnOriginWith
isDISABLED
, this identifies the integer response code for requests the origin identifies as invalid. - validate_
on_ strorigin_ with - 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.
- validation_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- allow
Large BooleanPost Body - Fails POST request bodies that exceed 16 KB when enabled, otherwise allows them to pass with no validation for policy compliance.
- cloudlet
Policy Property Map - Identifies the Cloudlet policy.
- enabled Boolean
- Applies the Input Validation Cloudlet behavior.
- failure302Uri String
- Specifies the redirect link for invalid requests that have not yet triggered a penalty.
- label String
- Distinguishes this Input Validation policy from any others within the same property.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- penalty302Uri String
- Specifies the redirect link for end users who trigger the penalty.
- penalty403Net
Storage StringPath - Specifies the full path to the static 403 response content relative to the
downloadDomainName
in thepenaltyNetStorage
object. - penalty
Action String - Once the
penaltyThreshold
of invalid requests is met, this specifies the response. - penalty
Branded NumberDeny Cache Ttl - Specifies the penalty response's time to live in the cache,
5
minutes by default. - penalty
Net Property MapStorage - 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 integercpCode
to track the traffic. - penalty
Threshold Number - Specifies the number of invalid requests permitted before executing the
penaltyAction
. - penalty
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- reset
On BooleanValid - 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 thepenaltyAction
. - template
Uuid String - This option is for internal usage only.
- Boolean
- When enabled, identifies users by the value of a cookie.
- user
Identification BooleanBy Headers - When enabled, identifies users by specific HTTP headers on GET or POST requests.
- user
Identification BooleanBy Ip - When enabled, identifies users by specific IP address. Do not enable this if you are concerned about DDoS attacks from many different IP addresses.
- user
Identification BooleanBy Params - When enabled, identifies users by specific query parameters on GET or POST requests.
- String
- This specifies the cookie name whose value needs to remain constant across requests to identify a user.
- user
Identification List<String>Key Headers - This specifies the HTTP headers whose combined set of values identify each end user.
- user
Identification List<String>Key Params - This specifies the query parameters whose combined set of values identify each end user.
- user
Identification StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- validate
On StringOrigin Header Name - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies the header name for a request that the origin identifies as invalid. - validate
On StringOrigin Header Value - If
validateOnOriginWith
is set toRESPONSE_CODE_AND_HEADER
, this specifies an invalid request's header value that corresponds to thevalidateOnOriginHeaderName
. - validate
On NumberOrigin Response Code - Unless
validateOnOriginWith
isDISABLED
, this identifies the integer response code for requests the origin identifies as invalid. - validate
On StringOrigin With - 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.
- validation
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationCloudletPolicy
GetPropertyRulesBuilderRulesV20230105BehaviorInputValidationPenaltyNetStorage
- Cp
Code int - Download
Domain stringName - G2o
Token string
- Cp
Code int - Download
Domain stringName - G2o
Token string
- cp
Code Integer - download
Domain StringName - g2o
Token String
- cp
Code number - download
Domain stringName - g2o
Token string
- cp_
code int - download_
domain_ strname - g2o_
token str
- cp
Code Number - download
Domain StringName - g2o
Token String
GetPropertyRulesBuilderRulesV20230105BehaviorInstant
- Custom
Link List<string>Relations - Specify link relation values that activate the prefetching behavior. For example, specifying
fetch
allows you to use shorterrel="fetch"
markup. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Prefetch
Cacheable bool - When enabled, applies prefetching only to objects already set to be cacheable, for example using the
caching
behavior. Only applies to content with thetieredDistribution
behavior enabled. - Prefetch
Html bool - 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. - Prefetch
No boolStore - 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 theprefetchNoStoreExtensions
option. Only applies to content with thesureRoute
behavior enabled. - Prefetch
No List<string>Store Extensions - Specifies a set of file extensions for which the
prefetchNoStore
option is allowed. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Custom
Link []stringRelations - Specify link relation values that activate the prefetching behavior. For example, specifying
fetch
allows you to use shorterrel="fetch"
markup. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Prefetch
Cacheable bool - When enabled, applies prefetching only to objects already set to be cacheable, for example using the
caching
behavior. Only applies to content with thetieredDistribution
behavior enabled. - Prefetch
Html bool - 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. - Prefetch
No boolStore - 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 theprefetchNoStoreExtensions
option. Only applies to content with thesureRoute
behavior enabled. - Prefetch
No []stringStore Extensions - Specifies a set of file extensions for which the
prefetchNoStore
option is allowed. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Link List<String>Relations - Specify link relation values that activate the prefetching behavior. For example, specifying
fetch
allows you to use shorterrel="fetch"
markup. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- 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 thetieredDistribution
behavior enabled. - prefetch
Html Boolean - 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. - prefetch
No BooleanStore - 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 theprefetchNoStoreExtensions
option. Only applies to content with thesureRoute
behavior enabled. - prefetch
No List<String>Store Extensions - Specifies a set of file extensions for which the
prefetchNoStore
option is allowed. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Link string[]Relations - Specify link relation values that activate the prefetching behavior. For example, specifying
fetch
allows you to use shorterrel="fetch"
markup. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- 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 thetieredDistribution
behavior enabled. - prefetch
Html boolean - 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. - prefetch
No booleanStore - 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 theprefetchNoStoreExtensions
option. Only applies to content with thesureRoute
behavior enabled. - prefetch
No string[]Store Extensions - Specifies a set of file extensions for which the
prefetchNoStore
option is allowed. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom_
link_ Sequence[str]relations - Specify link relation values that activate the prefetching behavior. For example, specifying
fetch
allows you to use shorterrel="fetch"
markup. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- prefetch_
cacheable bool - When enabled, applies prefetching only to objects already set to be cacheable, for example using the
caching
behavior. Only applies to content with thetieredDistribution
behavior enabled. - prefetch_
html bool - 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. - prefetch_
no_ boolstore - 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 theprefetchNoStoreExtensions
option. Only applies to content with thesureRoute
behavior enabled. - prefetch_
no_ Sequence[str]store_ extensions - Specifies a set of file extensions for which the
prefetchNoStore
option is allowed. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Link List<String>Relations - Specify link relation values that activate the prefetching behavior. For example, specifying
fetch
allows you to use shorterrel="fetch"
markup. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- 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 thetieredDistribution
behavior enabled. - prefetch
Html Boolean - 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. - prefetch
No BooleanStore - 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 theprefetchNoStoreExtensions
option. Only applies to content with thesureRoute
behavior enabled. - prefetch
No List<String>Store Extensions - Specifies a set of file extensions for which the
prefetchNoStore
option is allowed. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorInstantConfig
- Enabled bool
- Enables the InstantConfig behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the InstantConfig behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the InstantConfig behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the InstantConfig behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the InstantConfig behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the InstantConfig behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimization
- Enable
Partial stringObject Caching - Specifies whether to cache partial objects.
- Enabled bool
- Enables the file optimization behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Maximum
Size string - Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. The size of a file can't be greater than 323 GB. If you need to optimize a larger file, contact Akamai Professional Services for help. This option is for internal usage only. - Minimum
Size string - Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. - Template
Uuid string - This option is for internal usage only.
- Use
Versioning bool - When
enablePartialObjectCaching
is set toPARTIAL_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. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enable
Partial stringObject Caching - Specifies whether to cache partial objects.
- Enabled bool
- Enables the file optimization behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Maximum
Size string - Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. The size of a file can't be greater than 323 GB. If you need to optimize a larger file, contact Akamai Professional Services for help. This option is for internal usage only. - Minimum
Size string - Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. - Template
Uuid string - This option is for internal usage only.
- Use
Versioning bool - When
enablePartialObjectCaching
is set toPARTIAL_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. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable
Partial StringObject Caching - Specifies whether to cache partial objects.
- enabled Boolean
- Enables the file optimization behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- maximum
Size String - Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. The size of a file can't be greater than 323 GB. If you need to optimize a larger file, contact Akamai Professional Services for help. This option is for internal usage only. - minimum
Size String - Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. - template
Uuid String - This option is for internal usage only.
- use
Versioning Boolean - When
enablePartialObjectCaching
is set toPARTIAL_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. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable
Partial stringObject Caching - Specifies whether to cache partial objects.
- enabled boolean
- Enables the file optimization behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- maximum
Size string - Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. The size of a file can't be greater than 323 GB. If you need to optimize a larger file, contact Akamai Professional Services for help. This option is for internal usage only. - minimum
Size string - Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. - template
Uuid string - This option is for internal usage only.
- use
Versioning boolean - When
enablePartialObjectCaching
is set toPARTIAL_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. - uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable_
partial_ strobject_ caching - Specifies whether to cache partial objects.
- enabled bool
- Enables the file optimization behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- maximum_
size str - Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. The size of a file can't be greater than 323 GB. If you need to optimize a larger file, contact Akamai Professional Services for help. This option is for internal usage only. - minimum_
size str - Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. - template_
uuid str - This option is for internal usage only.
- use_
versioning bool - When
enablePartialObjectCaching
is set toPARTIAL_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. - uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable
Partial StringObject Caching - Specifies whether to cache partial objects.
- enabled Boolean
- Enables the file optimization behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- maximum
Size String - Optimization does not apply to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. The size of a file can't be greater than 323 GB. If you need to optimize a larger file, contact Akamai Professional Services for help. This option is for internal usage only. - minimum
Size String - Optimization only applies to files larger than this, expressed as a number suffixed with a unit string such as
MB
orGB
. - template
Uuid String - This option is for internal usage only.
- use
Versioning Boolean - When
enablePartialObjectCaching
is set toPARTIAL_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. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorLargeFileOptimizationAdvanced
- Enabled bool
- Enables the file optimization behavior.
- Fragment
Size string - Specifies the size of each fragment used for partial object caching.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Object
Size string - Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a
MB
orGB
suffix. - Prefetch
After intRequest - The number of POC fragments to prefetch after the request.
- Prefetch
During intRequest - The number of POC fragments to prefetch during the request.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the file optimization behavior.
- Fragment
Size string - Specifies the size of each fragment used for partial object caching.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Object
Size string - Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a
MB
orGB
suffix. - Prefetch
After intRequest - The number of POC fragments to prefetch after the request.
- Prefetch
During intRequest - The number of POC fragments to prefetch during the request.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the file optimization behavior.
- fragment
Size String - Specifies the size of each fragment used for partial object caching.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size String - Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a
MB
orGB
suffix. - prefetch
After IntegerRequest - The number of POC fragments to prefetch after the request.
- prefetch
During IntegerRequest - The number of POC fragments to prefetch during the request.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the file optimization behavior.
- fragment
Size string - Specifies the size of each fragment used for partial object caching.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size string - Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a
MB
orGB
suffix. - prefetch
After numberRequest - The number of POC fragments to prefetch after the request.
- prefetch
During numberRequest - The number of POC fragments to prefetch during the request.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the file optimization behavior.
- fragment_
size str - Specifies the size of each fragment used for partial object caching.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object_
size str - Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a
MB
orGB
suffix. - prefetch_
after_ intrequest - The number of POC fragments to prefetch after the request.
- prefetch_
during_ intrequest - The number of POC fragments to prefetch during the request.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the file optimization behavior.
- fragment
Size String - Specifies the size of each fragment used for partial object caching.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- object
Size String - Specifies the size of the file at which point to apply partial object (POC) caching. Append a numeric value with a
MB
orGB
suffix. - prefetch
After NumberRequest - The number of POC fragments to prefetch after the request.
- prefetch
During NumberRequest - The number of POC fragments to prefetch during the request.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRate
- Bitrate
Tables List<GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Bitrate Table> - Specifies a download rate that corresponds to a
thresholdTable
entry. The bit rate appears as a two-member object consisting of a numericbitrateValue
and abitrateUnit
string, with allowed values ofKbps
,Mbps
, andGbps
. - Enabled bool
- When enabled, activates the bit rate limiting behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Threshold
Tables List<GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Threshold Table> - 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 numericthresholdValue
andthresholdUnit
string, with allowed values ofSECONDS
orBYTES
. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Bitrate
Tables []GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Bitrate Table - Specifies a download rate that corresponds to a
thresholdTable
entry. The bit rate appears as a two-member object consisting of a numericbitrateValue
and abitrateUnit
string, with allowed values ofKbps
,Mbps
, andGbps
. - Enabled bool
- When enabled, activates the bit rate limiting behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Threshold
Tables []GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Threshold Table - 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 numericthresholdValue
andthresholdUnit
string, with allowed values ofSECONDS
orBYTES
. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- bitrate
Tables List<GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Bitrate Table> - Specifies a download rate that corresponds to a
thresholdTable
entry. The bit rate appears as a two-member object consisting of a numericbitrateValue
and abitrateUnit
string, with allowed values ofKbps
,Mbps
, andGbps
. - enabled Boolean
- When enabled, activates the bit rate limiting behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- threshold
Tables List<GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Threshold Table> - 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 numericthresholdValue
andthresholdUnit
string, with allowed values ofSECONDS
orBYTES
. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- bitrate
Tables GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Bitrate Table[] - Specifies a download rate that corresponds to a
thresholdTable
entry. The bit rate appears as a two-member object consisting of a numericbitrateValue
and abitrateUnit
string, with allowed values ofKbps
,Mbps
, andGbps
. - enabled boolean
- When enabled, activates the bit rate limiting behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- threshold
Tables GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Threshold Table[] - 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 numericthresholdValue
andthresholdUnit
string, with allowed values ofSECONDS
orBYTES
. - uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- bitrate_
tables Sequence[GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Bitrate Table] - Specifies a download rate that corresponds to a
thresholdTable
entry. The bit rate appears as a two-member object consisting of a numericbitrateValue
and abitrateUnit
string, with allowed values ofKbps
,Mbps
, andGbps
. - enabled bool
- When enabled, activates the bit rate limiting behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- threshold_
tables Sequence[GetProperty Rules Builder Rules V20230105Behavior Limit Bit Rate Threshold Table] - 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 numericthresholdValue
andthresholdUnit
string, with allowed values ofSECONDS
orBYTES
. - uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- bitrate
Tables List<Property Map> - Specifies a download rate that corresponds to a
thresholdTable
entry. The bit rate appears as a two-member object consisting of a numericbitrateValue
and abitrateUnit
string, with allowed values ofKbps
,Mbps
, andGbps
. - enabled Boolean
- When enabled, activates the bit rate limiting behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- threshold
Tables List<Property Map> - 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 numericthresholdValue
andthresholdUnit
string, with allowed values ofSECONDS
orBYTES
. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateBitrateTable
- Bitrate
Unit string - The unit of measurement, either
KBPS
,MBPS
, orGBPS
. - Bitrate
Value double - The numeric indicator of the download rate.
- Bitrate
Unit string - The unit of measurement, either
KBPS
,MBPS
, orGBPS
. - Bitrate
Value float64 - The numeric indicator of the download rate.
- bitrate
Unit String - The unit of measurement, either
KBPS
,MBPS
, orGBPS
. - bitrate
Value Double - The numeric indicator of the download rate.
- bitrate
Unit string - The unit of measurement, either
KBPS
,MBPS
, orGBPS
. - bitrate
Value number - The numeric indicator of the download rate.
- bitrate_
unit str - The unit of measurement, either
KBPS
,MBPS
, orGBPS
. - bitrate_
value float - The numeric indicator of the download rate.
- bitrate
Unit String - The unit of measurement, either
KBPS
,MBPS
, orGBPS
. - bitrate
Value Number - The numeric indicator of the download rate.
GetPropertyRulesBuilderRulesV20230105BehaviorLimitBitRateThresholdTable
- Threshold
Unit string - The unit of measurement, either
SECONDS
of the elapsed download time, orBYTES
of the file size. - Threshold
Value int - The numeric indicator of the minimum file size or elapsed download time.
- Threshold
Unit string - The unit of measurement, either
SECONDS
of the elapsed download time, orBYTES
of the file size. - Threshold
Value int - The numeric indicator of the minimum file size or elapsed download time.
- threshold
Unit String - The unit of measurement, either
SECONDS
of the elapsed download time, orBYTES
of the file size. - threshold
Value Integer - The numeric indicator of the minimum file size or elapsed download time.
- threshold
Unit string - The unit of measurement, either
SECONDS
of the elapsed download time, orBYTES
of the file size. - threshold
Value number - The numeric indicator of the minimum file size or elapsed download time.
- threshold_
unit str - The unit of measurement, either
SECONDS
of the elapsed download time, orBYTES
of the file size. - threshold_
value int - The numeric indicator of the minimum file size or elapsed download time.
- threshold
Unit String - The unit of measurement, either
SECONDS
of the elapsed download time, orBYTES
of the file size. - threshold
Value Number - The numeric indicator of the minimum file size or elapsed download time.
GetPropertyRulesBuilderRulesV20230105BehaviorLogCustom
- Custom
Log stringField - Specifies an additional data field to append to each log line, maximum 1000 bytes, typically based on a dynamically generated built-in system variable. For example,
round-trip: {{builtin.AK_CLIENT_TURNAROUND_TIME}}ms
logs the total time to complete the response. SeeSupport for variables
for more information. Since this option can specify both a request and response, it overrides anycustomLogField
settings in thereport
behavior. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Log
Custom boolLog Field - Whether to append additional custom data to each log line.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Custom
Log stringField - Specifies an additional data field to append to each log line, maximum 1000 bytes, typically based on a dynamically generated built-in system variable. For example,
round-trip: {{builtin.AK_CLIENT_TURNAROUND_TIME}}ms
logs the total time to complete the response. SeeSupport for variables
for more information. Since this option can specify both a request and response, it overrides anycustomLogField
settings in thereport
behavior. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Log
Custom boolLog Field - Whether to append additional custom data to each log line.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Log StringField - Specifies an additional data field to append to each log line, maximum 1000 bytes, typically based on a dynamically generated built-in system variable. For example,
round-trip: {{builtin.AK_CLIENT_TURNAROUND_TIME}}ms
logs the total time to complete the response. SeeSupport for variables
for more information. Since this option can specify both a request and response, it overrides anycustomLogField
settings in thereport
behavior. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- log
Custom BooleanLog Field - Whether to append additional custom data to each log line.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Log stringField - Specifies an additional data field to append to each log line, maximum 1000 bytes, typically based on a dynamically generated built-in system variable. For example,
round-trip: {{builtin.AK_CLIENT_TURNAROUND_TIME}}ms
logs the total time to complete the response. SeeSupport for variables
for more information. Since this option can specify both a request and response, it overrides anycustomLogField
settings in thereport
behavior. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- log
Custom booleanLog Field - Whether to append additional custom data to each log line.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom_
log_ strfield - Specifies an additional data field to append to each log line, maximum 1000 bytes, typically based on a dynamically generated built-in system variable. For example,
round-trip: {{builtin.AK_CLIENT_TURNAROUND_TIME}}ms
logs the total time to complete the response. SeeSupport for variables
for more information. Since this option can specify both a request and response, it overrides anycustomLogField
settings in thereport
behavior. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- log_
custom_ boollog_ field - Whether to append additional custom data to each log line.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Log StringField - Specifies an additional data field to append to each log line, maximum 1000 bytes, typically based on a dynamically generated built-in system variable. For example,
round-trip: {{builtin.AK_CLIENT_TURNAROUND_TIME}}ms
logs the total time to complete the response. SeeSupport for variables
for more information. Since this option can specify both a request and response, it overrides anycustomLogField
settings in thereport
behavior. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- log
Custom BooleanLog Field - Whether to append additional custom data to each log line.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorMPulse
- Api
Key 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
. - Buffer
Size string - Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
- Config
Override 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}}"
. SeeConfiguration Overrides
for more information. - Enabled bool
- Applies performance monitoring to this behavior's set of content.
- Loader
Version string - Specifies the version of the Boomerang JavaScript loader snippet. See
mPulse Loader Snippets
for more information. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Require
Pci bool - Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
- Template
Uuid string - This option is for internal usage only.
- Title
Optional string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Api
Key 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
. - Buffer
Size string - Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
- Config
Override 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}}"
. SeeConfiguration Overrides
for more information. - Enabled bool
- Applies performance monitoring to this behavior's set of content.
- Loader
Version string - Specifies the version of the Boomerang JavaScript loader snippet. See
mPulse Loader Snippets
for more information. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Require
Pci bool - Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
- Template
Uuid string - This option is for internal usage only.
- Title
Optional string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- api
Key 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
. - buffer
Size String - Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
- config
Override 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}}"
. SeeConfiguration Overrides
for more information. - enabled Boolean
- Applies performance monitoring to this behavior's set of content.
- loader
Version String - Specifies the version of the Boomerang JavaScript loader snippet. See
mPulse Loader Snippets
for more information. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- require
Pci Boolean - Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
- template
Uuid String - This option is for internal usage only.
- title
Optional String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- api
Key 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
. - buffer
Size string - Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
- config
Override 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}}"
. SeeConfiguration Overrides
for more information. - enabled boolean
- Applies performance monitoring to this behavior's set of content.
- loader
Version string - Specifies the version of the Boomerang JavaScript loader snippet. See
mPulse Loader Snippets
for more information. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- require
Pci boolean - Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
- template
Uuid string - This option is for internal usage only.
- title
Optional string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- api_
key str - This generated value uniquely identifies sections of your website for you to analyze independently. To access this value, see
Enable mPulse in Property Manager
. - buffer_
size str - Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
- config_
override str - 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}}"
. SeeConfiguration Overrides
for more information. - enabled bool
- Applies performance monitoring to this behavior's set of content.
- loader_
version str - Specifies the version of the Boomerang JavaScript loader snippet. See
mPulse Loader Snippets
for more information. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- require_
pci bool - Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
- template_
uuid str - This option is for internal usage only.
- title_
optional str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- api
Key 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
. - buffer
Size String - Allows you to override the browser's default (150) maximum number of reported performance timeline entries.
- config
Override 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}}"
. SeeConfiguration Overrides
for more information. - enabled Boolean
- Applies performance monitoring to this behavior's set of content.
- loader
Version String - Specifies the version of the Boomerang JavaScript loader snippet. See
mPulse Loader Snippets
for more information. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- require
Pci Boolean - Suppresses gathering metrics for potentially sensitive end-user interactions. Enabling this omits data from some older browsers.
- template
Uuid String - This option is for internal usage only.
- title
Optional String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorManifestPersonalization
- Enabled bool
- Enables the Manifest Personalization feature.
- Hls
Enable boolDebug Headers - Includes additional
Akamai-Manifest-Personalization
andAkamai-Manifest-Personalization-Config-Source
debugging headers. - Hls
Enabled bool - Allows you to customize the HLS master manifest that's sent to the requesting client.
- Hls
Filter stringIn Bitrate Ranges - 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. - Hls
Filter stringIn Bitrates - 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. - Hls
Mode string - Applies with
hlsEnabled
on. - Hls
Preferred stringBitrate - 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. - Hls
Query boolParam Enabled - Specifies 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.
- Hls
Query stringParam Secret Key - Specifies a primary key as a token to accompany the request.
- Hls
Query stringParam Transition Key - Specifies a transition key as a token to accompany the request.
- Hls
Show boolAdvanced - Allows you to configure advanced settings.
- Hls
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the Manifest Personalization feature.
- Hls
Enable boolDebug Headers - Includes additional
Akamai-Manifest-Personalization
andAkamai-Manifest-Personalization-Config-Source
debugging headers. - Hls
Enabled bool - Allows you to customize the HLS master manifest that's sent to the requesting client.
- Hls
Filter stringIn Bitrate Ranges - 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. - Hls
Filter stringIn Bitrates - 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. - Hls
Mode string - Applies with
hlsEnabled
on. - Hls
Preferred stringBitrate - 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. - Hls
Query boolParam Enabled - Specifies 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.
- Hls
Query stringParam Secret Key - Specifies a primary key as a token to accompany the request.
- Hls
Query stringParam Transition Key - Specifies a transition key as a token to accompany the request.
- Hls
Show boolAdvanced - Allows you to configure advanced settings.
- Hls
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Manifest Personalization feature.
- hls
Enable BooleanDebug Headers - Includes additional
Akamai-Manifest-Personalization
andAkamai-Manifest-Personalization-Config-Source
debugging headers. - hls
Enabled Boolean - Allows you to customize the HLS master manifest that's sent to the requesting client.
- hls
Filter StringIn Bitrate Ranges - 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. - hls
Filter StringIn Bitrates - 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. - hls
Mode String - Applies with
hlsEnabled
on. - hls
Preferred StringBitrate - 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. - hls
Query BooleanParam Enabled - Specifies 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.
- hls
Query StringParam Secret Key - Specifies a primary key as a token to accompany the request.
- hls
Query StringParam Transition Key - Specifies a transition key as a token to accompany the request.
- hls
Show BooleanAdvanced - Allows you to configure advanced settings.
- hls
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the Manifest Personalization feature.
- hls
Enable booleanDebug Headers - Includes additional
Akamai-Manifest-Personalization
andAkamai-Manifest-Personalization-Config-Source
debugging headers. - hls
Enabled boolean - Allows you to customize the HLS master manifest that's sent to the requesting client.
- hls
Filter stringIn Bitrate Ranges - 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. - hls
Filter stringIn Bitrates - 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. - hls
Mode string - Applies with
hlsEnabled
on. - hls
Preferred stringBitrate - 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. - hls
Query booleanParam Enabled - Specifies 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.
- hls
Query stringParam Secret Key - Specifies a primary key as a token to accompany the request.
- hls
Query stringParam Transition Key - Specifies a transition key as a token to accompany the request.
- hls
Show booleanAdvanced - Allows you to configure advanced settings.
- hls
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the Manifest Personalization feature.
- hls_
enable_ booldebug_ headers - Includes additional
Akamai-Manifest-Personalization
andAkamai-Manifest-Personalization-Config-Source
debugging headers. - hls_
enabled bool - Allows you to customize the HLS master manifest that's sent to the requesting client.
- hls_
filter_ strin_ bitrate_ ranges - 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. - hls_
filter_ strin_ bitrates - 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. - hls_
mode str - Applies with
hlsEnabled
on. - hls_
preferred_ strbitrate - 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. - hls_
query_ boolparam_ enabled - Specifies 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.
- hls_
query_ strparam_ secret_ key - Specifies a primary key as a token to accompany the request.
- hls_
query_ strparam_ transition_ key - Specifies a transition key as a token to accompany the request.
- hls_
show_ booladvanced - Allows you to configure advanced settings.
- hls_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Manifest Personalization feature.
- hls
Enable BooleanDebug Headers - Includes additional
Akamai-Manifest-Personalization
andAkamai-Manifest-Personalization-Config-Source
debugging headers. - hls
Enabled Boolean - Allows you to customize the HLS master manifest that's sent to the requesting client.
- hls
Filter StringIn Bitrate Ranges - 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. - hls
Filter StringIn Bitrates - 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. - hls
Mode String - Applies with
hlsEnabled
on. - hls
Preferred StringBitrate - 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. - hls
Query BooleanParam Enabled - Specifies 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.
- hls
Query StringParam Secret Key - Specifies a primary key as a token to accompany the request.
- hls
Query StringParam Transition Key - Specifies a transition key as a token to accompany the request.
- hls
Show BooleanAdvanced - Allows you to configure advanced settings.
- hls
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorManifestRerouting
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Partner string
- Set this value to
adobe_primetime
, which is an external technology partner that provides value added offerings, like advertisement integration, to the requested media objects. - Template
Uuid string - This option is for internal usage only.
- Username string
- The user name for your Adobe Primetime account.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Partner string
- Set this value to
adobe_primetime
, which is an external technology partner that provides value added offerings, like advertisement integration, to the requested media objects. - Template
Uuid string - This option is for internal usage only.
- Username string
- The user name for your Adobe Primetime account.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- partner String
- Set this value to
adobe_primetime
, which is an external technology partner that provides value added offerings, like advertisement integration, to the requested media objects. - template
Uuid String - This option is for internal usage only.
- username String
- The user name for your Adobe Primetime account.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- partner string
- Set this value to
adobe_primetime
, which is an external technology partner that provides value added offerings, like advertisement integration, to the requested media objects. - template
Uuid string - This option is for internal usage only.
- username string
- The user name for your Adobe Primetime account.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- partner str
- Set this value to
adobe_primetime
, which is an external technology partner that provides value added offerings, like advertisement integration, to the requested media objects. - template_
uuid str - This option is for internal usage only.
- username str
- The user name for your Adobe Primetime account.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- partner String
- Set this value to
adobe_primetime
, which is an external technology partner that provides value added offerings, like advertisement integration, to the requested media objects. - template
Uuid String - This option is for internal usage only.
- username String
- The user name for your Adobe Primetime account.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorManualServerPush
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Serverpushlists List<string>
- 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
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Serverpushlists []string
- 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
. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- serverpushlists List<String>
- 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
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- serverpushlists string[]
- 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
. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- serverpushlists Sequence[str]
- 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
. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- serverpushlists List<String>
- 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
. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorMediaAcceleration
- Enabled bool
- Enables Media Acceleration.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables Media Acceleration.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables Media Acceleration.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables Media Acceleration.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables Media Acceleration.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables Media Acceleration.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorMediaAccelerationQuicOptout
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Optout string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Optout string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- optout String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- optout string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- optout str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- optout String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorMediaClient
- Beacon
Id string - Specifies the ID of data source's beacon.
- Enabled bool
- Enables client-side download analytics.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Use
Hybrid boolHttp Udp - Enables the hybrid HTTP/UDP protocol.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Beacon
Id string - Specifies the ID of data source's beacon.
- Enabled bool
- Enables client-side download analytics.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Use
Hybrid boolHttp Udp - Enables the hybrid HTTP/UDP protocol.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- beacon
Id String - Specifies the ID of data source's beacon.
- enabled Boolean
- Enables client-side download analytics.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- use
Hybrid BooleanHttp Udp - Enables the hybrid HTTP/UDP protocol.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- beacon
Id string - Specifies the ID of data source's beacon.
- enabled boolean
- Enables client-side download analytics.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- use
Hybrid booleanHttp Udp - Enables the hybrid HTTP/UDP protocol.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- beacon_
id str - Specifies the ID of data source's beacon.
- enabled bool
- Enables client-side download analytics.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- use_
hybrid_ boolhttp_ udp - Enables the hybrid HTTP/UDP protocol.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- beacon
Id String - Specifies the ID of data source's beacon.
- enabled Boolean
- Enables client-side download analytics.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- use
Hybrid BooleanHttp Udp - Enables the hybrid HTTP/UDP protocol.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorMediaFileRetrievalOptimization
- Enabled bool
- Enables the partial-object caching behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the partial-object caching behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the partial-object caching behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the partial-object caching behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the partial-object caching behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the partial-object caching behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorMediaOriginFailover
- Cache
Error boolResponse - When enabled, caches the error response.
- Cache
Window string - This sets error response's TTL.
- Client
Response stringCode - Specifies the response code served to the client.
- bool
- Allows you to configure failover settings when the origin has content errors.
- string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- bool
- Allows you to configure failover settings when the origin server responds with errors.
- string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Detect
Origin boolUnresponsive - Allows you to configure what happens when the origin is unresponsive.
- Detect
Origin stringUnresponsive Title - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- This specifies the redirect's destination hostname.
- string
- This specifies the origin hostname.
- bool
- Enabling this blacklists the origin's IP address.
- string
- This sets the delay before blacklisting an IP address.
- bool
- Changes the request protocol.
- string
- Specify
RESPONSE_CODES
, the only available option. - bool
- Enabling this includes the original set of query parameters.
- string
- This specifies the path to form the new URL.
- bool
- Enabling this allows you to modify the request path.
- string
- Specifies either the
HTTP
orHTTPS
protocol. - string
- This sets the recovery option.
- int
- Specifies a redirect response code.
- List<string>
- Specifies the set of response codes identifying when there are content errors.
- string
- Sets how many times to retry.
- string
- This specifies the redirect's destination hostname.
- string
- This specifies the origin hostname.
- bool
- Enabling this blacklists the origin's IP address.
- string
- This sets the delay before blacklisting an IP address.
- bool
- Modifies the request protocol.
- string
- Specify
RESPONSE_CODES
, the only available option. - bool
- Enabling this includes the original set of query parameters.
- string
- This specifies the path to form the new URL.
- bool
- Modifies the request path.
- string
- Specifies either the
HTTP
orHTTPS
protocol. - string
- This sets the recovery option.
- int
- Specifies either a redirect response code.
- List<string>
- Specifies the set of response codes identifying when the origin responds with errors.
- string
- Sets how many times to retry.
- Origin
Unresponsive stringAlternate Host - This specifies the redirect's destination hostname.
- Origin
Unresponsive stringBackup Host - This specifies the origin hostname.
- Origin
Unresponsive boolBlacklist Origin Ip - Enabling this blacklists the origin's IP address.
- Origin
Unresponsive stringBlacklist Window - This sets the delay before blacklisting an IP address.
- Origin
Unresponsive boolChange Protocol - This allows you to change the request protocol.
- Origin
Unresponsive stringDetection Level - Specify the level of response to slow origin connections.
- Origin
Unresponsive boolInclude Query String - Enabling this includes the original set of query parameters.
- Origin
Unresponsive stringModified Path - This specifies the path to form the new URL.
- Origin
Unresponsive boolModify Request Path - Modifies the request path.
- Origin
Unresponsive stringProtocol - Specifies which protocol to use.
- Origin
Unresponsive stringRecovery - This sets the recovery option.
- Origin
Unresponsive intRedirect Method - Specifies the redirect response code.
- Origin
Unresponsive stringRetry Limit - Sets how many times to retry.
- Other
Options string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Cache
Error boolResponse - When enabled, caches the error response.
- Cache
Window string - This sets error response's TTL.
- Client
Response stringCode - Specifies the response code served to the client.
- bool
- Allows you to configure failover settings when the origin has content errors.
- string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- bool
- Allows you to configure failover settings when the origin server responds with errors.
- string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Detect
Origin boolUnresponsive - Allows you to configure what happens when the origin is unresponsive.
- Detect
Origin stringUnresponsive Title - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- This specifies the redirect's destination hostname.
- string
- This specifies the origin hostname.
- bool
- Enabling this blacklists the origin's IP address.
- string
- This sets the delay before blacklisting an IP address.
- bool
- Changes the request protocol.
- string
- Specify
RESPONSE_CODES
, the only available option. - bool
- Enabling this includes the original set of query parameters.
- string
- This specifies the path to form the new URL.
- bool
- Enabling this allows you to modify the request path.
- string
- Specifies either the
HTTP
orHTTPS
protocol. - string
- This sets the recovery option.
- int
- Specifies a redirect response code.
- []string
- Specifies the set of response codes identifying when there are content errors.
- string
- Sets how many times to retry.
- string
- This specifies the redirect's destination hostname.
- string
- This specifies the origin hostname.
- bool
- Enabling this blacklists the origin's IP address.
- string
- This sets the delay before blacklisting an IP address.
- bool
- Modifies the request protocol.
- string
- Specify
RESPONSE_CODES
, the only available option. - bool
- Enabling this includes the original set of query parameters.
- string
- This specifies the path to form the new URL.
- bool
- Modifies the request path.
- string
- Specifies either the
HTTP
orHTTPS
protocol. - string
- This sets the recovery option.
- int
- Specifies either a redirect response code.
- []string
- Specifies the set of response codes identifying when the origin responds with errors.
- string
- Sets how many times to retry.
- Origin
Unresponsive stringAlternate Host - This specifies the redirect's destination hostname.
- Origin
Unresponsive stringBackup Host - This specifies the origin hostname.
- Origin
Unresponsive boolBlacklist Origin Ip - Enabling this blacklists the origin's IP address.
- Origin
Unresponsive stringBlacklist Window - This sets the delay before blacklisting an IP address.
- Origin
Unresponsive boolChange Protocol - This allows you to change the request protocol.
- Origin
Unresponsive stringDetection Level - Specify the level of response to slow origin connections.
- Origin
Unresponsive boolInclude Query String - Enabling this includes the original set of query parameters.
- Origin
Unresponsive stringModified Path - This specifies the path to form the new URL.
- Origin
Unresponsive boolModify Request Path - Modifies the request path.
- Origin
Unresponsive stringProtocol - Specifies which protocol to use.
- Origin
Unresponsive stringRecovery - This sets the recovery option.
- Origin
Unresponsive intRedirect Method - Specifies the redirect response code.
- Origin
Unresponsive stringRetry Limit - Sets how many times to retry.
- Other
Options string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cache
Error BooleanResponse - When enabled, caches the error response.
- cache
Window String - This sets error response's TTL.
- client
Response StringCode - Specifies the response code served to the client.
- Boolean
- Allows you to configure failover settings when the origin has content errors.
- String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Boolean
- Allows you to configure failover settings when the origin server responds with errors.
- String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- detect
Origin BooleanUnresponsive - Allows you to configure what happens when the origin is unresponsive.
- detect
Origin StringUnresponsive Title - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- String
- This specifies the redirect's destination hostname.
- String
- This specifies the origin hostname.
- Boolean
- Enabling this blacklists the origin's IP address.
- String
- This sets the delay before blacklisting an IP address.
- Boolean
- Changes the request protocol.
- String
- Specify
RESPONSE_CODES
, the only available option. - Boolean
- Enabling this includes the original set of query parameters.
- String
- This specifies the path to form the new URL.
- Boolean
- Enabling this allows you to modify the request path.
- String
- Specifies either the
HTTP
orHTTPS
protocol. - String
- This sets the recovery option.
- Integer
- Specifies a redirect response code.
- List<String>
- Specifies the set of response codes identifying when there are content errors.
- String
- Sets how many times to retry.
- String
- This specifies the redirect's destination hostname.
- String
- This specifies the origin hostname.
- Boolean
- Enabling this blacklists the origin's IP address.
- String
- This sets the delay before blacklisting an IP address.
- Boolean
- Modifies the request protocol.
- String
- Specify
RESPONSE_CODES
, the only available option. - Boolean
- Enabling this includes the original set of query parameters.
- String
- This specifies the path to form the new URL.
- Boolean
- Modifies the request path.
- String
- Specifies either the
HTTP
orHTTPS
protocol. - String
- This sets the recovery option.
- Integer
- Specifies either a redirect response code.
- List<String>
- Specifies the set of response codes identifying when the origin responds with errors.
- String
- Sets how many times to retry.
- origin
Unresponsive StringAlternate Host - This specifies the redirect's destination hostname.
- origin
Unresponsive StringBackup Host - This specifies the origin hostname.
- origin
Unresponsive BooleanBlacklist Origin Ip - Enabling this blacklists the origin's IP address.
- origin
Unresponsive StringBlacklist Window - This sets the delay before blacklisting an IP address.
- origin
Unresponsive BooleanChange Protocol - This allows you to change the request protocol.
- origin
Unresponsive StringDetection Level - Specify the level of response to slow origin connections.
- origin
Unresponsive BooleanInclude Query String - Enabling this includes the original set of query parameters.
- origin
Unresponsive StringModified Path - This specifies the path to form the new URL.
- origin
Unresponsive BooleanModify Request Path - Modifies the request path.
- origin
Unresponsive StringProtocol - Specifies which protocol to use.
- origin
Unresponsive StringRecovery - This sets the recovery option.
- origin
Unresponsive IntegerRedirect Method - Specifies the redirect response code.
- origin
Unresponsive StringRetry Limit - Sets how many times to retry.
- other
Options String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cache
Error booleanResponse - When enabled, caches the error response.
- cache
Window string - This sets error response's TTL.
- client
Response stringCode - Specifies the response code served to the client.
- boolean
- Allows you to configure failover settings when the origin has content errors.
- string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- boolean
- Allows you to configure failover settings when the origin server responds with errors.
- string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- detect
Origin booleanUnresponsive - Allows you to configure what happens when the origin is unresponsive.
- detect
Origin stringUnresponsive Title - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- This specifies the redirect's destination hostname.
- string
- This specifies the origin hostname.
- boolean
- Enabling this blacklists the origin's IP address.
- string
- This sets the delay before blacklisting an IP address.
- boolean
- Changes the request protocol.
- string
- Specify
RESPONSE_CODES
, the only available option. - boolean
- Enabling this includes the original set of query parameters.
- string
- This specifies the path to form the new URL.
- boolean
- Enabling this allows you to modify the request path.
- string
- Specifies either the
HTTP
orHTTPS
protocol. - string
- This sets the recovery option.
- number
- Specifies a redirect response code.
- string[]
- Specifies the set of response codes identifying when there are content errors.
- string
- Sets how many times to retry.
- string
- This specifies the redirect's destination hostname.
- string
- This specifies the origin hostname.
- boolean
- Enabling this blacklists the origin's IP address.
- string
- This sets the delay before blacklisting an IP address.
- boolean
- Modifies the request protocol.
- string
- Specify
RESPONSE_CODES
, the only available option. - boolean
- Enabling this includes the original set of query parameters.
- string
- This specifies the path to form the new URL.
- boolean
- Modifies the request path.
- string
- Specifies either the
HTTP
orHTTPS
protocol. - string
- This sets the recovery option.
- number
- Specifies either a redirect response code.
- string[]
- Specifies the set of response codes identifying when the origin responds with errors.
- string
- Sets how many times to retry.
- origin
Unresponsive stringAlternate Host - This specifies the redirect's destination hostname.
- origin
Unresponsive stringBackup Host - This specifies the origin hostname.
- origin
Unresponsive booleanBlacklist Origin Ip - Enabling this blacklists the origin's IP address.
- origin
Unresponsive stringBlacklist Window - This sets the delay before blacklisting an IP address.
- origin
Unresponsive booleanChange Protocol - This allows you to change the request protocol.
- origin
Unresponsive stringDetection Level - Specify the level of response to slow origin connections.
- origin
Unresponsive booleanInclude Query String - Enabling this includes the original set of query parameters.
- origin
Unresponsive stringModified Path - This specifies the path to form the new URL.
- origin
Unresponsive booleanModify Request Path - Modifies the request path.
- origin
Unresponsive stringProtocol - Specifies which protocol to use.
- origin
Unresponsive stringRecovery - This sets the recovery option.
- origin
Unresponsive numberRedirect Method - Specifies the redirect response code.
- origin
Unresponsive stringRetry Limit - Sets how many times to retry.
- other
Options string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cache_
error_ boolresponse - When enabled, caches the error response.
- cache_
window str - This sets error response's TTL.
- client_
response_ strcode - Specifies the response code served to the client.
- bool
- Allows you to configure failover settings when the origin has content errors.
- str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- bool
- Allows you to configure failover settings when the origin server responds with errors.
- str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- detect_
origin_ boolunresponsive - Allows you to configure what happens when the origin is unresponsive.
- detect_
origin_ strunresponsive_ title - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- str
- This specifies the redirect's destination hostname.
- str
- This specifies the origin hostname.
- bool
- Enabling this blacklists the origin's IP address.
- str
- This sets the delay before blacklisting an IP address.
- bool
- Changes the request protocol.
- str
- Specify
RESPONSE_CODES
, the only available option. - bool
- Enabling this includes the original set of query parameters.
- str
- This specifies the path to form the new URL.
- bool
- Enabling this allows you to modify the request path.
- str
- Specifies either the
HTTP
orHTTPS
protocol. - str
- This sets the recovery option.
- int
- Specifies a redirect response code.
- Sequence[str]
- Specifies the set of response codes identifying when there are content errors.
- str
- Sets how many times to retry.
- str
- This specifies the redirect's destination hostname.
- str
- This specifies the origin hostname.
- bool
- Enabling this blacklists the origin's IP address.
- str
- This sets the delay before blacklisting an IP address.
- bool
- Modifies the request protocol.
- str
- Specify
RESPONSE_CODES
, the only available option. - bool
- Enabling this includes the original set of query parameters.
- str
- This specifies the path to form the new URL.
- bool
- Modifies the request path.
- str
- Specifies either the
HTTP
orHTTPS
protocol. - str
- This sets the recovery option.
- int
- Specifies either a redirect response code.
- Sequence[str]
- Specifies the set of response codes identifying when the origin responds with errors.
- str
- Sets how many times to retry.
- origin_
unresponsive_ stralternate_ host - This specifies the redirect's destination hostname.
- origin_
unresponsive_ strbackup_ host - This specifies the origin hostname.
- origin_
unresponsive_ boolblacklist_ origin_ ip - Enabling this blacklists the origin's IP address.
- origin_
unresponsive_ strblacklist_ window - This sets the delay before blacklisting an IP address.
- origin_
unresponsive_ boolchange_ protocol - This allows you to change the request protocol.
- origin_
unresponsive_ strdetection_ level - Specify the level of response to slow origin connections.
- origin_
unresponsive_ boolinclude_ query_ string - Enabling this includes the original set of query parameters.
- origin_
unresponsive_ strmodified_ path - This specifies the path to form the new URL.
- origin_
unresponsive_ boolmodify_ request_ path - Modifies the request path.
- origin_
unresponsive_ strprotocol - Specifies which protocol to use.
- origin_
unresponsive_ strrecovery - This sets the recovery option.
- origin_
unresponsive_ intredirect_ method - Specifies the redirect response code.
- origin_
unresponsive_ strretry_ limit - Sets how many times to retry.
- other_
options str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cache
Error BooleanResponse - When enabled, caches the error response.
- cache
Window String - This sets error response's TTL.
- client
Response StringCode - Specifies the response code served to the client.
- Boolean
- Allows you to configure failover settings when the origin has content errors.
- String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Boolean
- Allows you to configure failover settings when the origin server responds with errors.
- String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- detect
Origin BooleanUnresponsive - Allows you to configure what happens when the origin is unresponsive.
- detect
Origin StringUnresponsive Title - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- String
- This specifies the redirect's destination hostname.
- String
- This specifies the origin hostname.
- Boolean
- Enabling this blacklists the origin's IP address.
- String
- This sets the delay before blacklisting an IP address.
- Boolean
- Changes the request protocol.
- String
- Specify
RESPONSE_CODES
, the only available option. - Boolean
- Enabling this includes the original set of query parameters.
- String
- This specifies the path to form the new URL.
- Boolean
- Enabling this allows you to modify the request path.
- String
- Specifies either the
HTTP
orHTTPS
protocol. - String
- This sets the recovery option.
- Number
- Specifies a redirect response code.
- List<String>
- Specifies the set of response codes identifying when there are content errors.
- String
- Sets how many times to retry.
- String
- This specifies the redirect's destination hostname.
- String
- This specifies the origin hostname.
- Boolean
- Enabling this blacklists the origin's IP address.
- String
- This sets the delay before blacklisting an IP address.
- Boolean
- Modifies the request protocol.
- String
- Specify
RESPONSE_CODES
, the only available option. - Boolean
- Enabling this includes the original set of query parameters.
- String
- This specifies the path to form the new URL.
- Boolean
- Modifies the request path.
- String
- Specifies either the
HTTP
orHTTPS
protocol. - String
- This sets the recovery option.
- Number
- Specifies either a redirect response code.
- List<String>
- Specifies the set of response codes identifying when the origin responds with errors.
- String
- Sets how many times to retry.
- origin
Unresponsive StringAlternate Host - This specifies the redirect's destination hostname.
- origin
Unresponsive StringBackup Host - This specifies the origin hostname.
- origin
Unresponsive BooleanBlacklist Origin Ip - Enabling this blacklists the origin's IP address.
- origin
Unresponsive StringBlacklist Window - This sets the delay before blacklisting an IP address.
- origin
Unresponsive BooleanChange Protocol - This allows you to change the request protocol.
- origin
Unresponsive StringDetection Level - Specify the level of response to slow origin connections.
- origin
Unresponsive BooleanInclude Query String - Enabling this includes the original set of query parameters.
- origin
Unresponsive StringModified Path - This specifies the path to form the new URL.
- origin
Unresponsive BooleanModify Request Path - Modifies the request path.
- origin
Unresponsive StringProtocol - Specifies which protocol to use.
- origin
Unresponsive StringRecovery - This sets the recovery option.
- origin
Unresponsive NumberRedirect Method - Specifies the redirect response code.
- origin
Unresponsive StringRetry Limit - Sets how many times to retry.
- other
Options String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorMetadataCaching
- Enabled bool
- Enables metadata caching.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables metadata caching.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables metadata caching.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables metadata caching.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables metadata caching.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables metadata caching.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorMobileSdkPerformance
- Enabled bool
- Enables the Mobile App Performance SDK.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Secondary
Multipath boolTo Origin - When enabled, sends secondary multi-path requests to the origin server.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the Mobile App Performance SDK.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Secondary
Multipath boolTo Origin - When enabled, sends secondary multi-path requests to the origin server.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Mobile App Performance SDK.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- secondary
Multipath BooleanTo Origin - When enabled, sends secondary multi-path requests to the origin server.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the Mobile App Performance SDK.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- secondary
Multipath booleanTo Origin - When enabled, sends secondary multi-path requests to the origin server.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the Mobile App Performance SDK.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- secondary_
multipath_ boolto_ origin - When enabled, sends secondary multi-path requests to the origin server.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the Mobile App Performance SDK.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- secondary
Multipath BooleanTo Origin - When enabled, sends secondary multi-path requests to the origin server.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingRequestHeader
- Action string
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP request headers. - Avoid
Duplicate boolHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - Custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - Header
Value string - Specifies the new header value.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- New
Header stringValue - Supplies an HTTP header replacement value.
- Standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - Standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - Standard
Modify stringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - Standard
Pass stringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Action string
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP request headers. - Avoid
Duplicate boolHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - Custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - Header
Value string - Specifies the new header value.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- New
Header stringValue - Supplies an HTTP header replacement value.
- Standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - Standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - Standard
Modify stringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - Standard
Pass stringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action String
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP request headers. - avoid
Duplicate BooleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header StringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value String - Specifies the new header value.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- new
Header StringValue - Supplies an HTTP header replacement value.
- standard
Add StringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete StringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify StringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - standard
Pass StringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action string
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP request headers. - avoid
Duplicate booleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value string - Specifies the new header value.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- new
Header stringValue - Supplies an HTTP header replacement value.
- standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify stringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - standard
Pass stringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action str
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP request headers. - avoid_
duplicate_ boolheaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom_
header_ strname - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header_
value str - Specifies the new header value.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- new_
header_ strvalue - Supplies an HTTP header replacement value.
- standard_
add_ strheader_ name - If the value of
action
isADD
, this specifies the name of the field to add. - standard_
delete_ strheader_ name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard_
modify_ strheader_ name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - standard_
pass_ strheader_ name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action String
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP request headers. - avoid
Duplicate BooleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header StringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value String - Specifies the new header value.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- new
Header StringValue - Supplies an HTTP header replacement value.
- standard
Add StringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete StringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify StringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - standard
Pass StringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorModifyIncomingResponseHeader
- Action string
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP response headers. - Avoid
Duplicate boolHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - Custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - Header
Value string - Specifies the header's new value.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- New
Header stringValue - Specifies an HTTP header replacement value.
- Standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - Standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - Standard
Modify stringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - Standard
Pass stringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Action string
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP response headers. - Avoid
Duplicate boolHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - Custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - Header
Value string - Specifies the header's new value.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- New
Header stringValue - Specifies an HTTP header replacement value.
- Standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - Standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - Standard
Modify stringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - Standard
Pass stringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action String
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP response headers. - avoid
Duplicate BooleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header StringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value String - Specifies the header's new value.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- new
Header StringValue - Specifies an HTTP header replacement value.
- standard
Add StringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete StringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify StringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - standard
Pass StringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action string
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP response headers. - avoid
Duplicate booleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value string - Specifies the header's new value.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- new
Header stringValue - Specifies an HTTP header replacement value.
- standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify stringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - standard
Pass stringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action str
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP response headers. - avoid_
duplicate_ boolheaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom_
header_ strname - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header_
value str - Specifies the header's new value.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- new_
header_ strvalue - Specifies an HTTP header replacement value.
- standard_
add_ strheader_ name - If the value of
action
isADD
, this specifies the name of the field to add. - standard_
delete_ strheader_ name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard_
modify_ strheader_ name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - standard_
pass_ strheader_ name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action String
- Either
ADD
,DELETE
,MODIFY
, orPASS
incoming HTTP response headers. - avoid
Duplicate BooleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header StringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value String - Specifies the header's new value.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- new
Header StringValue - Specifies an HTTP header replacement value.
- standard
Add StringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete StringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify StringHeader Name - If the value of
action
isMODIFY
, this specifies the name of the field to modify. - standard
Pass StringHeader Name - If the value of
action
isPASS
, this specifies the name of the field to pass through. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingRequestHeader
- Action string
- Either
ADD
orDELETE
outgoing HTTP request headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - Avoid
Duplicate boolHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - Custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - Header
Value string - Specifies the new header value.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Match
Multiple bool - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - New
Header stringValue - Specifies an HTTP header replacement value.
- Regex
Header stringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- Regex
Header stringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - Standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - Standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - Standard
Modify stringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Action string
- Either
ADD
orDELETE
outgoing HTTP request headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - Avoid
Duplicate boolHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - Custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - Header
Value string - Specifies the new header value.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Match
Multiple bool - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - New
Header stringValue - Specifies an HTTP header replacement value.
- Regex
Header stringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- Regex
Header stringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - Standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - Standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - Standard
Modify stringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action String
- Either
ADD
orDELETE
outgoing HTTP request headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - avoid
Duplicate BooleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header StringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value String - Specifies the new header value.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Multiple Boolean - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - new
Header StringValue - Specifies an HTTP header replacement value.
- regex
Header StringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- regex
Header StringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - standard
Add StringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete StringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify StringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action string
- Either
ADD
orDELETE
outgoing HTTP request headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - avoid
Duplicate booleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value string - Specifies the new header value.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Multiple boolean - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - new
Header stringValue - Specifies an HTTP header replacement value.
- regex
Header stringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- regex
Header stringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify stringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action str
- Either
ADD
orDELETE
outgoing HTTP request headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - avoid_
duplicate_ boolheaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom_
header_ strname - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header_
value str - Specifies the new header value.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match_
multiple bool - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - new_
header_ strvalue - Specifies an HTTP header replacement value.
- regex_
header_ strmatch - Specifies a Perl-compatible regular expression to match within the header value.
- regex_
header_ strreplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - standard_
add_ strheader_ name - If the value of
action
isADD
, this specifies the name of the field to add. - standard_
delete_ strheader_ name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard_
modify_ strheader_ name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action String
- Either
ADD
orDELETE
outgoing HTTP request headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - avoid
Duplicate BooleanHeaders - When enabled with the
action
set toMODIFY
, prevents creation of more than one instance of a header. - custom
Header StringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value String - Specifies the new header value.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Multiple Boolean - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - new
Header StringValue - Specifies an HTTP header replacement value.
- regex
Header StringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- regex
Header StringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - standard
Add StringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete StringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify StringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorModifyOutgoingResponseHeader
- Action string
- Either
ADD
orDELETE
outgoing HTTP response headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - Avoid
Duplicate boolHeaders - When enabled with the
action
set toMODIFY
, 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. - Custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - Header
Value string - Specifies the existing value of the header to match.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Match
Multiple bool - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - New
Header stringValue - Specifies the new HTTP header replacement value.
- Regex
Header stringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- Regex
Header stringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - Standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - Standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - Standard
Modify stringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Action string
- Either
ADD
orDELETE
outgoing HTTP response headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - Avoid
Duplicate boolHeaders - When enabled with the
action
set toMODIFY
, 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. - Custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - Header
Value string - Specifies the existing value of the header to match.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Match
Multiple bool - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - New
Header stringValue - Specifies the new HTTP header replacement value.
- Regex
Header stringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- Regex
Header stringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - Standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - Standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - Standard
Modify stringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action String
- Either
ADD
orDELETE
outgoing HTTP response headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - avoid
Duplicate BooleanHeaders - When enabled with the
action
set toMODIFY
, 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. - custom
Header StringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value String - Specifies the existing value of the header to match.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Multiple Boolean - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - new
Header StringValue - Specifies the new HTTP header replacement value.
- regex
Header StringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- regex
Header StringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - standard
Add StringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete StringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify StringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action string
- Either
ADD
orDELETE
outgoing HTTP response headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - avoid
Duplicate booleanHeaders - When enabled with the
action
set toMODIFY
, 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. - custom
Header stringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value string - Specifies the existing value of the header to match.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Multiple boolean - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - new
Header stringValue - Specifies the new HTTP header replacement value.
- regex
Header stringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- regex
Header stringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - standard
Add stringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete stringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify stringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action str
- Either
ADD
orDELETE
outgoing HTTP response headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - avoid_
duplicate_ boolheaders - When enabled with the
action
set toMODIFY
, 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. - custom_
header_ strname - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header_
value str - Specifies the existing value of the header to match.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match_
multiple bool - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - new_
header_ strvalue - Specifies the new HTTP header replacement value.
- regex_
header_ strmatch - Specifies a Perl-compatible regular expression to match within the header value.
- regex_
header_ strreplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - standard_
add_ strheader_ name - If the value of
action
isADD
, this specifies the name of the field to add. - standard_
delete_ strheader_ name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard_
modify_ strheader_ name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- action String
- Either
ADD
orDELETE
outgoing HTTP response headers,MODIFY
their fixed values, or specify aREGEX
pattern to transform them. - avoid
Duplicate BooleanHeaders - When enabled with the
action
set toMODIFY
, 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. - custom
Header StringName - Specifies a custom field name that applies when the relevant
standard
header name is set toOTHER
. - header
Value String - Specifies the existing value of the header to match.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- match
Multiple Boolean - When enabled with the
action
set toREGEX
, replaces all occurrences of the matched regular expression, otherwise only the first match if disabled. - new
Header StringValue - Specifies the new HTTP header replacement value.
- regex
Header StringMatch - Specifies a Perl-compatible regular expression to match within the header value.
- regex
Header StringReplace - Specifies text that replaces the
regexHeaderMatch
pattern within the header value. - standard
Add StringHeader Name - If the value of
action
isADD
, this specifies the name of the field to add. - standard
Delete StringHeader Name - If the value of
action
isDELETE
, this specifies the name of the field to remove. - standard
Modify StringHeader Name - If the value of
action
isMODIFY
orREGEX
, this specifies the name of the field to modify. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorModifyViaHeader
- Enabled bool
- Enables
Via
header modifications. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Modification
Option string - Specify how you want to handle the header.
- Rename
Header stringTo - Specifies a new name to replace the existing
Via
header. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables
Via
header modifications. - Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Modification
Option string - Specify how you want to handle the header.
- Rename
Header stringTo - Specifies a new name to replace the existing
Via
header. - Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables
Via
header modifications. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- modification
Option String - Specify how you want to handle the header.
- rename
Header StringTo - Specifies a new name to replace the existing
Via
header. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables
Via
header modifications. - locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- modification
Option string - Specify how you want to handle the header.
- rename
Header stringTo - Specifies a new name to replace the existing
Via
header. - template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables
Via
header modifications. - locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- modification_
option str - Specify how you want to handle the header.
- rename_
header_ strto - Specifies a new name to replace the existing
Via
header. - template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables
Via
header modifications. - locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- modification
Option String - Specify how you want to handle the header.
- rename
Header StringTo - Specifies a new name to replace the existing
Via
header. - template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorOrigin
- Cache
Key stringHostname - Specifies the hostname to use when forming a cache key.
- Compress bool
- Enables
gzip
compression for non-NetStorage origins. - List<Get
Property Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority> - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - Custom
Certificates List<GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate> - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - Custom
Forward stringHost Header - This specifies the name of the custom host header the edge server should pass to the origin.
- Custom
Valid List<string>Cn Values - Specifies values to look for in the origin certificate's
Subject Alternate Name
orCommon 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-linevariables
, which use the same curly-brace syntax.) - Enable
True boolClient Ip - 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 standardX-Forward-For
header, which proxies may modify. - Forward
Host stringHeader - When the
originType
is set to eitherCUSTOMER
orSAAS_DYNAMIC_ORIGIN
, this specifies whichHost
header to pass to the origin. - Hostname string
- Specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.
- Http
Port int - Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily
80
. - Https
Port int - 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. SeeSecure property requirements
for guidance. - Ip
Version string - Specifies which IP version to use when getting content from the origin.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Mslorigin string
- This specifies the media's origin server.
- Net
Storage GetProperty Rules Builder Rules V20230105Behavior Origin Net Storage - Specifies the details of the NetStorage server.
- Origin
Certificate string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Origin
Certs stringTo Honor - Specifies which certificate to trust.
- Origin
Id string - Identifies the Edge Load Balancing origin. This needs to correspond to an
edgeLoadBalancingOrigin
behavior'sid
attribute within the same property. - Origin
Sni bool - 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. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for more information. If you want to use TLS version 1.3 in your existing properties, enable this option. New properties have this enabled by default. - Origin
Type string - Choose where your content is retrieved from.
- Ports string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Saas
Cname boolEnabled - Enabling this allows you to use a
CNAME chain
to determine the hostname for this SaaS dynamic origin. - Saas
Cname intLevel - Specifies the desired number of hostnames to use in the
CNAME chain
, starting backwards from the edge server. - string
- Specifies the name of the cookie that identifies this SaaS dynamic origin.
- Saas
Query stringString - Specifies the name of the query parameter that identifies this SaaS dynamic origin.
- Saas
Regex string - Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
- Saas
Replace string - Specifies replacement text for what
saasRegex
matches. - Saas
Suffix string - Specifies the static part of the SaaS dynamic origin.
- Saas
Type string - Specifies the part of the request that identifies this SaaS dynamic origin.
- Second
Hostname string - Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
- Second
Hostname boolEnabled - Available only for certain products. This specifies whether you want to use an additional origin server address.
- List<string>
- Template
Uuid string - This option is for internal usage only.
- True
Client boolIp Client Setting - 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. - True
Client stringIp Header - This specifies the name of the field that identifies the end client's IP address, for example
True-Client-IP
. - Use
Unique boolCache Key - With a shared
hostname
such as provided by Amazon AWS, sets a unique cache key for your content. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Verification
Mode string - For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
- Cache
Key stringHostname - Specifies the hostname to use when forming a cache key.
- Compress bool
- Enables
gzip
compression for non-NetStorage origins. - []Get
Property Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - Custom
Certificates []GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - Custom
Forward stringHost Header - This specifies the name of the custom host header the edge server should pass to the origin.
- Custom
Valid []stringCn Values - Specifies values to look for in the origin certificate's
Subject Alternate Name
orCommon 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-linevariables
, which use the same curly-brace syntax.) - Enable
True boolClient Ip - 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 standardX-Forward-For
header, which proxies may modify. - Forward
Host stringHeader - When the
originType
is set to eitherCUSTOMER
orSAAS_DYNAMIC_ORIGIN
, this specifies whichHost
header to pass to the origin. - Hostname string
- Specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.
- Http
Port int - Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily
80
. - Https
Port int - 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. SeeSecure property requirements
for guidance. - Ip
Version string - Specifies which IP version to use when getting content from the origin.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Mslorigin string
- This specifies the media's origin server.
- Net
Storage GetProperty Rules Builder Rules V20230105Behavior Origin Net Storage - Specifies the details of the NetStorage server.
- Origin
Certificate string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Origin
Certs stringTo Honor - Specifies which certificate to trust.
- Origin
Id string - Identifies the Edge Load Balancing origin. This needs to correspond to an
edgeLoadBalancingOrigin
behavior'sid
attribute within the same property. - Origin
Sni bool - 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. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for more information. If you want to use TLS version 1.3 in your existing properties, enable this option. New properties have this enabled by default. - Origin
Type string - Choose where your content is retrieved from.
- Ports string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Saas
Cname boolEnabled - Enabling this allows you to use a
CNAME chain
to determine the hostname for this SaaS dynamic origin. - Saas
Cname intLevel - Specifies the desired number of hostnames to use in the
CNAME chain
, starting backwards from the edge server. - string
- Specifies the name of the cookie that identifies this SaaS dynamic origin.
- Saas
Query stringString - Specifies the name of the query parameter that identifies this SaaS dynamic origin.
- Saas
Regex string - Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
- Saas
Replace string - Specifies replacement text for what
saasRegex
matches. - Saas
Suffix string - Specifies the static part of the SaaS dynamic origin.
- Saas
Type string - Specifies the part of the request that identifies this SaaS dynamic origin.
- Second
Hostname string - Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
- Second
Hostname boolEnabled - Available only for certain products. This specifies whether you want to use an additional origin server address.
- []string
- Template
Uuid string - This option is for internal usage only.
- True
Client boolIp Client Setting - 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. - True
Client stringIp Header - This specifies the name of the field that identifies the end client's IP address, for example
True-Client-IP
. - Use
Unique boolCache Key - With a shared
hostname
such as provided by Amazon AWS, sets a unique cache key for your content. - Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Verification
Mode string - For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
- cache
Key StringHostname - Specifies the hostname to use when forming a cache key.
- compress Boolean
- Enables
gzip
compression for non-NetStorage origins. - List<Get
Property Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority> - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - custom
Certificates List<GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate> - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - custom
Forward StringHost Header - This specifies the name of the custom host header the edge server should pass to the origin.
- custom
Valid List<String>Cn Values - Specifies values to look for in the origin certificate's
Subject Alternate Name
orCommon 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-linevariables
, which use the same curly-brace syntax.) - enable
True BooleanClient Ip - 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 standardX-Forward-For
header, which proxies may modify. - forward
Host StringHeader - When the
originType
is set to eitherCUSTOMER
orSAAS_DYNAMIC_ORIGIN
, this specifies whichHost
header to pass to the origin. - hostname String
- Specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.
- http
Port Integer - Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily
80
. - https
Port Integer - 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. SeeSecure property requirements
for guidance. - ip
Version String - Specifies which IP version to use when getting content from the origin.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- mslorigin String
- This specifies the media's origin server.
- net
Storage GetProperty Rules Builder Rules V20230105Behavior Origin Net Storage - Specifies the details of the NetStorage server.
- origin
Certificate String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- origin
Certs StringTo Honor - Specifies which certificate to trust.
- origin
Id String - Identifies the Edge Load Balancing origin. This needs to correspond to an
edgeLoadBalancingOrigin
behavior'sid
attribute within the same property. - origin
Sni 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. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for more information. If you want to use TLS version 1.3 in your existing properties, enable this option. New properties have this enabled by default. - origin
Type String - Choose where your content is retrieved from.
- ports String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- saas
Cname BooleanEnabled - Enabling this allows you to use a
CNAME chain
to determine the hostname for this SaaS dynamic origin. - saas
Cname IntegerLevel - Specifies the desired number of hostnames to use in the
CNAME chain
, starting backwards from the edge server. - String
- Specifies the name of the cookie that identifies this SaaS dynamic origin.
- saas
Query StringString - Specifies the name of the query parameter that identifies this SaaS dynamic origin.
- saas
Regex String - Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
- saas
Replace String - Specifies replacement text for what
saasRegex
matches. - saas
Suffix String - Specifies the static part of the SaaS dynamic origin.
- saas
Type String - Specifies the part of the request that identifies this SaaS dynamic origin.
- second
Hostname String - Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
- second
Hostname BooleanEnabled - Available only for certain products. This specifies whether you want to use an additional origin server address.
- List<String>
- template
Uuid String - This option is for internal usage only.
- true
Client BooleanIp Client Setting - 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. - true
Client StringIp Header - This specifies the name of the field that identifies the end client's IP address, for example
True-Client-IP
. - use
Unique BooleanCache Key - With a shared
hostname
such as provided by Amazon AWS, sets a unique cache key for your content. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- verification
Mode String - For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
- cache
Key stringHostname - Specifies the hostname to use when forming a cache key.
- compress boolean
- Enables
gzip
compression for non-NetStorage origins. - Get
Property Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority[] - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - custom
Certificates GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate[] - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - custom
Forward stringHost Header - This specifies the name of the custom host header the edge server should pass to the origin.
- custom
Valid string[]Cn Values - Specifies values to look for in the origin certificate's
Subject Alternate Name
orCommon 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-linevariables
, which use the same curly-brace syntax.) - enable
True booleanClient Ip - 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 standardX-Forward-For
header, which proxies may modify. - forward
Host stringHeader - When the
originType
is set to eitherCUSTOMER
orSAAS_DYNAMIC_ORIGIN
, this specifies whichHost
header to pass to the origin. - hostname string
- Specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.
- http
Port number - Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily
80
. - https
Port 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. SeeSecure property requirements
for guidance. - ip
Version string - Specifies which IP version to use when getting content from the origin.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- mslorigin string
- This specifies the media's origin server.
- net
Storage GetProperty Rules Builder Rules V20230105Behavior Origin Net Storage - Specifies the details of the NetStorage server.
- origin
Certificate string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- origin
Certs stringTo Honor - Specifies which certificate to trust.
- origin
Id string - Identifies the Edge Load Balancing origin. This needs to correspond to an
edgeLoadBalancingOrigin
behavior'sid
attribute within the same property. - origin
Sni 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. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for more information. If you want to use TLS version 1.3 in your existing properties, enable this option. New properties have this enabled by default. - origin
Type string - Choose where your content is retrieved from.
- ports string
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- saas
Cname booleanEnabled - Enabling this allows you to use a
CNAME chain
to determine the hostname for this SaaS dynamic origin. - saas
Cname numberLevel - Specifies the desired number of hostnames to use in the
CNAME chain
, starting backwards from the edge server. - string
- Specifies the name of the cookie that identifies this SaaS dynamic origin.
- saas
Query stringString - Specifies the name of the query parameter that identifies this SaaS dynamic origin.
- saas
Regex string - Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
- saas
Replace string - Specifies replacement text for what
saasRegex
matches. - saas
Suffix string - Specifies the static part of the SaaS dynamic origin.
- saas
Type string - Specifies the part of the request that identifies this SaaS dynamic origin.
- second
Hostname string - Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
- second
Hostname booleanEnabled - Available only for certain products. This specifies whether you want to use an additional origin server address.
- string[]
- template
Uuid string - This option is for internal usage only.
- true
Client booleanIp Client Setting - 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. - true
Client stringIp Header - This specifies the name of the field that identifies the end client's IP address, for example
True-Client-IP
. - use
Unique booleanCache Key - With a shared
hostname
such as provided by Amazon AWS, sets a unique cache key for your content. - uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- verification
Mode string - For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
- cache_
key_ strhostname - Specifies the hostname to use when forming a cache key.
- compress bool
- Enables
gzip
compression for non-NetStorage origins. - Sequence[Get
Property Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority] - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - custom_
certificates Sequence[GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate] - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - custom_
forward_ strhost_ header - This specifies the name of the custom host header the edge server should pass to the origin.
- custom_
valid_ Sequence[str]cn_ values - Specifies values to look for in the origin certificate's
Subject Alternate Name
orCommon 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-linevariables
, which use the same curly-brace syntax.) - enable_
true_ boolclient_ ip - 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 standardX-Forward-For
header, which proxies may modify. - forward_
host_ strheader - When the
originType
is set to eitherCUSTOMER
orSAAS_DYNAMIC_ORIGIN
, this specifies whichHost
header to pass to the origin. - hostname str
- Specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.
- http_
port int - Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily
80
. - https_
port int - 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. SeeSecure property requirements
for guidance. - ip_
version str - Specifies which IP version to use when getting content from the origin.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- mslorigin str
- This specifies the media's origin server.
- net_
storage GetProperty Rules Builder Rules V20230105Behavior Origin Net Storage - Specifies the details of the NetStorage server.
- origin_
certificate str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- origin_
certs_ strto_ honor - Specifies which certificate to trust.
- origin_
id str - Identifies the Edge Load Balancing origin. This needs to correspond to an
edgeLoadBalancingOrigin
behavior'sid
attribute within the same property. - origin_
sni bool - 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. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for more information. If you want to use TLS version 1.3 in your existing properties, enable this option. New properties have this enabled by default. - origin_
type str - Choose where your content is retrieved from.
- ports str
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- saas_
cname_ boolenabled - Enabling this allows you to use a
CNAME chain
to determine the hostname for this SaaS dynamic origin. - saas_
cname_ intlevel - Specifies the desired number of hostnames to use in the
CNAME chain
, starting backwards from the edge server. - str
- Specifies the name of the cookie that identifies this SaaS dynamic origin.
- saas_
query_ strstring - Specifies the name of the query parameter that identifies this SaaS dynamic origin.
- saas_
regex str - Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
- saas_
replace str - Specifies replacement text for what
saasRegex
matches. - saas_
suffix str - Specifies the static part of the SaaS dynamic origin.
- saas_
type str - Specifies the part of the request that identifies this SaaS dynamic origin.
- second_
hostname str - Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
- second_
hostname_ boolenabled - Available only for certain products. This specifies whether you want to use an additional origin server address.
- Sequence[str]
- template_
uuid str - This option is for internal usage only.
- true_
client_ boolip_ client_ setting - 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. - true_
client_ strip_ header - This specifies the name of the field that identifies the end client's IP address, for example
True-Client-IP
. - use_
unique_ boolcache_ key - With a shared
hostname
such as provided by Amazon AWS, sets a unique cache key for your content. - uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- verification_
mode str - For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
- cache
Key StringHostname - Specifies the hostname to use when forming a cache key.
- compress Boolean
- Enables
gzip
compression for non-NetStorage origins. - List<Property Map>
- Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - custom
Certificates List<Property Map> - Specifies an array of certification objects. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for details on this object's requirements. - custom
Forward StringHost Header - This specifies the name of the custom host header the edge server should pass to the origin.
- custom
Valid List<String>Cn Values - Specifies values to look for in the origin certificate's
Subject Alternate Name
orCommon 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-linevariables
, which use the same curly-brace syntax.) - enable
True BooleanClient Ip - 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 standardX-Forward-For
header, which proxies may modify. - forward
Host StringHeader - When the
originType
is set to eitherCUSTOMER
orSAAS_DYNAMIC_ORIGIN
, this specifies whichHost
header to pass to the origin. - hostname String
- Specifies the hostname or IPv4 address of your origin server, from which edge servers can retrieve your content.
- http
Port Number - Specifies the port on your origin server to which edge servers should connect for HTTP requests, customarily
80
. - https
Port 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. SeeSecure property requirements
for guidance. - ip
Version String - Specifies which IP version to use when getting content from the origin.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- mslorigin String
- This specifies the media's origin server.
- net
Storage Property Map - Specifies the details of the NetStorage server.
- origin
Certificate String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- origin
Certs StringTo Honor - Specifies which certificate to trust.
- origin
Id String - Identifies the Edge Load Balancing origin. This needs to correspond to an
edgeLoadBalancingOrigin
behavior'sid
attribute within the same property. - origin
Sni 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. See the
verification settings in the Origin Server behavior
or contact your Akamai representative for more information. If you want to use TLS version 1.3 in your existing properties, enable this option. New properties have this enabled by default. - origin
Type String - Choose where your content is retrieved from.
- ports String
- This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- saas
Cname BooleanEnabled - Enabling this allows you to use a
CNAME chain
to determine the hostname for this SaaS dynamic origin. - saas
Cname NumberLevel - Specifies the desired number of hostnames to use in the
CNAME chain
, starting backwards from the edge server. - String
- Specifies the name of the cookie that identifies this SaaS dynamic origin.
- saas
Query StringString - Specifies the name of the query parameter that identifies this SaaS dynamic origin.
- saas
Regex String - Specifies the Perl-compatible regular expression match that identifies this SaaS dynamic origin.
- saas
Replace String - Specifies replacement text for what
saasRegex
matches. - saas
Suffix String - Specifies the static part of the SaaS dynamic origin.
- saas
Type String - Specifies the part of the request that identifies this SaaS dynamic origin.
- second
Hostname String - Specifies the origin server's hostname, IPv4 address, or IPv6 address. Edge servers retrieve your content from this origin server.
- second
Hostname BooleanEnabled - Available only for certain products. This specifies whether you want to use an additional origin server address.
- List<String>
- template
Uuid String - This option is for internal usage only.
- true
Client BooleanIp Client Setting - 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. - true
Client StringIp Header - This specifies the name of the field that identifies the end client's IP address, for example
True-Client-IP
. - use
Unique BooleanCache Key - With a shared
hostname
such as provided by Amazon AWS, sets a unique cache key for your content. - uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- verification
Mode String - For non-NetStorage origins, maximize security by controlling which certificates edge servers should trust.
GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristics
- Access
Key boolEncrypted Storage - Enables secure use of access keys defined in Cloud Access Manager. Access keys store encrypted authentication details required to sign requests to cloud origins. If you disable this option, you'll need to store the authentication details unencrypted.
- Adc
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Authentication
Method string - Specifies the authentication method.
- Authentication
Method stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Aws
Access stringKey Id - Specifies active access key ID linked to your AWS account.
- Aws
Access stringKey Version Guid - Identifies the unique
awsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to AWS S3. - Aws
Host string - This specifies the AWS hostname, without
http://
orhttps://
prefixes. If you leave this option empty, it inherits the hostname from theorigin
behavior. - Aws
Region string - This specifies the AWS region code of the location where your bucket resides.
- Aws
Secret stringAccess Key - Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
- Aws
Service string - This specifies the subdomain of your AWS service. It precedes
amazonaws.com
or the region code in the AWS hostname. For example,s3.amazonaws.com
. - Country string
- Specifies the origin's geographic region.
- Custom
Sign List<string>Strings - Specifies the data to be encrypted as a series of enumerated variable names. See
Built-in system variables
for guidance on each. - Direct
Connect stringGeo - Provides a region used by Akamai Direct Connection.
- Encoding
Version int - Specifies the version of the encryption algorithm, an integer from
1
to5
. - Gcs
Access stringKey Version Guid - Identifies the unique
gcsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode. - Gcs
Hmac stringKey Access Id - Specifies the active access ID linked to your Google account.
- Gcs
Hmac stringKey Secret - Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Mslkey string
- Specifies the access key provided by the hosting service.
- Mslname string
- Specifies the origin name provided by the hosting service.
- Nonce string
- Specifies the nonce.
- Secret
Key string - Specifies the shared secret key.
- Template
Uuid string - This option is for internal usage only.
- Use
Custom boolSign String - Specifies whether to customize your signed string.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Access
Key boolEncrypted Storage - Enables secure use of access keys defined in Cloud Access Manager. Access keys store encrypted authentication details required to sign requests to cloud origins. If you disable this option, you'll need to store the authentication details unencrypted.
- Adc
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Authentication
Method string - Specifies the authentication method.
- Authentication
Method stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Aws
Access stringKey Id - Specifies active access key ID linked to your AWS account.
- Aws
Access stringKey Version Guid - Identifies the unique
awsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to AWS S3. - Aws
Host string - This specifies the AWS hostname, without
http://
orhttps://
prefixes. If you leave this option empty, it inherits the hostname from theorigin
behavior. - Aws
Region string - This specifies the AWS region code of the location where your bucket resides.
- Aws
Secret stringAccess Key - Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
- Aws
Service string - This specifies the subdomain of your AWS service. It precedes
amazonaws.com
or the region code in the AWS hostname. For example,s3.amazonaws.com
. - Country string
- Specifies the origin's geographic region.
- Custom
Sign []stringStrings - Specifies the data to be encrypted as a series of enumerated variable names. See
Built-in system variables
for guidance on each. - Direct
Connect stringGeo - Provides a region used by Akamai Direct Connection.
- Encoding
Version int - Specifies the version of the encryption algorithm, an integer from
1
to5
. - Gcs
Access stringKey Version Guid - Identifies the unique
gcsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode. - Gcs
Hmac stringKey Access Id - Specifies the active access ID linked to your Google account.
- Gcs
Hmac stringKey Secret - Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Mslkey string
- Specifies the access key provided by the hosting service.
- Mslname string
- Specifies the origin name provided by the hosting service.
- Nonce string
- Specifies the nonce.
- Secret
Key string - Specifies the shared secret key.
- Template
Uuid string - This option is for internal usage only.
- Use
Custom boolSign String - Specifies whether to customize your signed string.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- access
Key BooleanEncrypted Storage - Enables secure use of access keys defined in Cloud Access Manager. Access keys store encrypted authentication details required to sign requests to cloud origins. If you disable this option, you'll need to store the authentication details unencrypted.
- adc
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- authentication
Method String - Specifies the authentication method.
- authentication
Method StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- aws
Access StringKey Id - Specifies active access key ID linked to your AWS account.
- aws
Access StringKey Version Guid - Identifies the unique
awsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to AWS S3. - aws
Host String - This specifies the AWS hostname, without
http://
orhttps://
prefixes. If you leave this option empty, it inherits the hostname from theorigin
behavior. - aws
Region String - This specifies the AWS region code of the location where your bucket resides.
- aws
Secret StringAccess Key - Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
- aws
Service String - This specifies the subdomain of your AWS service. It precedes
amazonaws.com
or the region code in the AWS hostname. For example,s3.amazonaws.com
. - country String
- Specifies the origin's geographic region.
- custom
Sign List<String>Strings - Specifies the data to be encrypted as a series of enumerated variable names. See
Built-in system variables
for guidance on each. - direct
Connect StringGeo - Provides a region used by Akamai Direct Connection.
- encoding
Version Integer - Specifies the version of the encryption algorithm, an integer from
1
to5
. - gcs
Access StringKey Version Guid - Identifies the unique
gcsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode. - gcs
Hmac StringKey Access Id - Specifies the active access ID linked to your Google account.
- gcs
Hmac StringKey Secret - Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- mslkey String
- Specifies the access key provided by the hosting service.
- mslname String
- Specifies the origin name provided by the hosting service.
- nonce String
- Specifies the nonce.
- secret
Key String - Specifies the shared secret key.
- template
Uuid String - This option is for internal usage only.
- use
Custom BooleanSign String - Specifies whether to customize your signed string.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- access
Key booleanEncrypted Storage - Enables secure use of access keys defined in Cloud Access Manager. Access keys store encrypted authentication details required to sign requests to cloud origins. If you disable this option, you'll need to store the authentication details unencrypted.
- adc
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- authentication
Method string - Specifies the authentication method.
- authentication
Method stringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- aws
Access stringKey Id - Specifies active access key ID linked to your AWS account.
- aws
Access stringKey Version Guid - Identifies the unique
awsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to AWS S3. - aws
Host string - This specifies the AWS hostname, without
http://
orhttps://
prefixes. If you leave this option empty, it inherits the hostname from theorigin
behavior. - aws
Region string - This specifies the AWS region code of the location where your bucket resides.
- aws
Secret stringAccess Key - Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
- aws
Service string - This specifies the subdomain of your AWS service. It precedes
amazonaws.com
or the region code in the AWS hostname. For example,s3.amazonaws.com
. - country string
- Specifies the origin's geographic region.
- custom
Sign string[]Strings - Specifies the data to be encrypted as a series of enumerated variable names. See
Built-in system variables
for guidance on each. - direct
Connect stringGeo - Provides a region used by Akamai Direct Connection.
- encoding
Version number - Specifies the version of the encryption algorithm, an integer from
1
to5
. - gcs
Access stringKey Version Guid - Identifies the unique
gcsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode. - gcs
Hmac stringKey Access Id - Specifies the active access ID linked to your Google account.
- gcs
Hmac stringKey Secret - Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- mslkey string
- Specifies the access key provided by the hosting service.
- mslname string
- Specifies the origin name provided by the hosting service.
- nonce string
- Specifies the nonce.
- secret
Key string - Specifies the shared secret key.
- template
Uuid string - This option is for internal usage only.
- use
Custom booleanSign String - Specifies whether to customize your signed string.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- access_
key_ boolencrypted_ storage - Enables secure use of access keys defined in Cloud Access Manager. Access keys store encrypted authentication details required to sign requests to cloud origins. If you disable this option, you'll need to store the authentication details unencrypted.
- adc_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- authentication_
method str - Specifies the authentication method.
- authentication_
method_ strtitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- aws_
access_ strkey_ id - Specifies active access key ID linked to your AWS account.
- aws_
access_ strkey_ version_ guid - Identifies the unique
awsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to AWS S3. - aws_
host str - This specifies the AWS hostname, without
http://
orhttps://
prefixes. If you leave this option empty, it inherits the hostname from theorigin
behavior. - aws_
region str - This specifies the AWS region code of the location where your bucket resides.
- aws_
secret_ straccess_ key - Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
- aws_
service str - This specifies the subdomain of your AWS service. It precedes
amazonaws.com
or the region code in the AWS hostname. For example,s3.amazonaws.com
. - country str
- Specifies the origin's geographic region.
- custom_
sign_ Sequence[str]strings - Specifies the data to be encrypted as a series of enumerated variable names. See
Built-in system variables
for guidance on each. - direct_
connect_ strgeo - Provides a region used by Akamai Direct Connection.
- encoding_
version int - Specifies the version of the encryption algorithm, an integer from
1
to5
. - gcs_
access_ strkey_ version_ guid - Identifies the unique
gcsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode. - gcs_
hmac_ strkey_ access_ id - Specifies the active access ID linked to your Google account.
- gcs_
hmac_ strkey_ secret - Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- mslkey str
- Specifies the access key provided by the hosting service.
- mslname str
- Specifies the origin name provided by the hosting service.
- nonce str
- Specifies the nonce.
- secret_
key str - Specifies the shared secret key.
- template_
uuid str - This option is for internal usage only.
- use_
custom_ boolsign_ string - Specifies whether to customize your signed string.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- access
Key BooleanEncrypted Storage - Enables secure use of access keys defined in Cloud Access Manager. Access keys store encrypted authentication details required to sign requests to cloud origins. If you disable this option, you'll need to store the authentication details unencrypted.
- adc
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- authentication
Method String - Specifies the authentication method.
- authentication
Method StringTitle - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- aws
Access StringKey Id - Specifies active access key ID linked to your AWS account.
- aws
Access StringKey Version Guid - Identifies the unique
awsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to AWS S3. - aws
Host String - This specifies the AWS hostname, without
http://
orhttps://
prefixes. If you leave this option empty, it inherits the hostname from theorigin
behavior. - aws
Region String - This specifies the AWS region code of the location where your bucket resides.
- aws
Secret StringAccess Key - Specifies the secret linked to the access key identifier that you want to use to sign requests to AWS.
- aws
Service String - This specifies the subdomain of your AWS service. It precedes
amazonaws.com
or the region code in the AWS hostname. For example,s3.amazonaws.com
. - country String
- Specifies the origin's geographic region.
- custom
Sign List<String>Strings - Specifies the data to be encrypted as a series of enumerated variable names. See
Built-in system variables
for guidance on each. - direct
Connect StringGeo - Provides a region used by Akamai Direct Connection.
- encoding
Version Number - Specifies the version of the encryption algorithm, an integer from
1
to5
. - gcs
Access StringKey Version Guid - Identifies the unique
gcsAccessKeyVersionGuid
access keycreated
in Cloud Access Manager to sign your requests to Google Cloud Storage in interoperability mode. - gcs
Hmac StringKey Access Id - Specifies the active access ID linked to your Google account.
- gcs
Hmac StringKey Secret - Specifies the secret linked to the access ID that you want to use to sign requests to Google Cloud Storage.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- mslkey String
- Specifies the access key provided by the hosting service.
- mslname String
- Specifies the origin name provided by the hosting service.
- nonce String
- Specifies the nonce.
- secret
Key String - Specifies the shared secret key.
- template
Uuid String - This option is for internal usage only.
- use
Custom BooleanSign String - Specifies whether to customize your signed string.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorOriginCharacteristicsWsd
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Origintype string
- Specifies an origin type.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Origintype string
- Specifies an origin type.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origintype String
- Specifies an origin type.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origintype string
- Specifies an origin type.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origintype str
- Specifies an origin type.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- origintype String
- Specifies an origin type.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificate
- Can
Be boolCa - Can
Be boolLeaf - Issuer
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Issuer Rdns - Not
After int - Not
Before int - Pem
Encoded stringCert - Public
Key string - Public
Key stringAlgorithm - Public
Key stringFormat - Self
Signed bool - Serial
Number string - Sha1Fingerprint string
- Sig
Alg stringName - Subject
Alternative List<string>Names - Subject
Cn string - Subject
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Subject Rdns - Version int
- Can
Be boolCa - Can
Be boolLeaf - Issuer
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Issuer Rdns - Not
After int - Not
Before int - Pem
Encoded stringCert - Public
Key string - Public
Key stringAlgorithm - Public
Key stringFormat - Self
Signed bool - Serial
Number string - Sha1Fingerprint string
- Sig
Alg stringName - Subject
Alternative []stringNames - Subject
Cn string - Subject
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Subject Rdns - Version int
- can
Be BooleanCa - can
Be BooleanLeaf - issuer
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Issuer Rdns - not
After Integer - not
Before Integer - pem
Encoded StringCert - public
Key String - public
Key StringAlgorithm - public
Key StringFormat - self
Signed Boolean - serial
Number String - sha1Fingerprint String
- sig
Alg StringName - subject
Alternative List<String>Names - subject
Cn String - subject
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Subject Rdns - version Integer
- can
Be booleanCa - can
Be booleanLeaf - issuer
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Issuer Rdns - not
After number - not
Before number - pem
Encoded stringCert - public
Key string - public
Key stringAlgorithm - public
Key stringFormat - self
Signed boolean - serial
Number string - sha1Fingerprint string
- sig
Alg stringName - subject
Alternative string[]Names - subject
Cn string - subject
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Subject Rdns - version number
- can_
be_ boolca - can_
be_ boolleaf - issuer_
rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Issuer Rdns - not_
after int - not_
before int - pem_
encoded_ strcert - public_
key str - public_
key_ stralgorithm - public_
key_ strformat - self_
signed bool - serial_
number str - sha1_
fingerprint str - sig_
alg_ strname - subject_
alternative_ Sequence[str]names - subject_
cn str - subject_
rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Subject Rdns - version int
- can
Be BooleanCa - can
Be BooleanLeaf - issuer
Rdns Property Map - not
After Number - not
Before Number - pem
Encoded StringCert - public
Key String - public
Key StringAlgorithm - public
Key StringFormat - self
Signed Boolean - serial
Number String - sha1Fingerprint String
- sig
Alg StringName - subject
Alternative List<String>Names - subject
Cn String - subject
Rdns Property Map - version Number
GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthority
- Can
Be boolCa - Can
Be boolLeaf - Issuer
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Issuer Rdns - Not
After int - Not
Before int - Pem
Encoded stringCert - Public
Key string - Public
Key stringAlgorithm - Public
Key stringFormat - Self
Signed bool - Serial
Number string - Sha1Fingerprint string
- Sig
Alg stringName - Subject
Alternative List<string>Names - Subject
Cn string - Subject
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Subject Rdns - Version int
- Can
Be boolCa - Can
Be boolLeaf - Issuer
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Issuer Rdns - Not
After int - Not
Before int - Pem
Encoded stringCert - Public
Key string - Public
Key stringAlgorithm - Public
Key stringFormat - Self
Signed bool - Serial
Number string - Sha1Fingerprint string
- Sig
Alg stringName - Subject
Alternative []stringNames - Subject
Cn string - Subject
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Subject Rdns - Version int
- can
Be BooleanCa - can
Be BooleanLeaf - issuer
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Issuer Rdns - not
After Integer - not
Before Integer - pem
Encoded StringCert - public
Key String - public
Key StringAlgorithm - public
Key StringFormat - self
Signed Boolean - serial
Number String - sha1Fingerprint String
- sig
Alg StringName - subject
Alternative List<String>Names - subject
Cn String - subject
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Subject Rdns - version Integer
- can
Be booleanCa - can
Be booleanLeaf - issuer
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Issuer Rdns - not
After number - not
Before number - pem
Encoded stringCert - public
Key string - public
Key stringAlgorithm - public
Key stringFormat - self
Signed boolean - serial
Number string - sha1Fingerprint string
- sig
Alg stringName - subject
Alternative string[]Names - subject
Cn string - subject
Rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Subject Rdns - version number
- can_
be_ boolca - can_
be_ boolleaf - issuer_
rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Issuer Rdns - not_
after int - not_
before int - pem_
encoded_ strcert - public_
key str - public_
key_ stralgorithm - public_
key_ strformat - self_
signed bool - serial_
number str - sha1_
fingerprint str - sig_
alg_ strname - subject_
alternative_ Sequence[str]names - subject_
cn str - subject_
rdns GetProperty Rules Builder Rules V20230105Behavior Origin Custom Certificate Authority Subject Rdns - version int
- can
Be BooleanCa - can
Be BooleanLeaf - issuer
Rdns Property Map - not
After Number - not
Before Number - pem
Encoded StringCert - public
Key String - public
Key StringAlgorithm - public
Key StringFormat - self
Signed Boolean - serial
Number String - sha1Fingerprint String
- sig
Alg StringName - subject
Alternative List<String>Names - subject
Cn String - subject
Rdns Property Map - version Number
GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthorityIssuerRdns
GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateAuthoritySubjectRdns
GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateIssuerRdns
GetPropertyRulesBuilderRulesV20230105BehaviorOriginCustomCertificateSubjectRdns
GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryMethod
- Custom
Status stringCode - Specifies the custom status code to be sent to the client.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Recovery
Method string - Specifies the recovery method.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Custom
Status stringCode - Specifies the custom status code to be sent to the client.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Recovery
Method string - Specifies the recovery method.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Status StringCode - Specifies the custom status code to be sent to the client.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- recovery
Method String - Specifies the recovery method.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Status stringCode - Specifies the custom status code to be sent to the client.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- recovery
Method string - Specifies the recovery method.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom_
status_ strcode - Specifies the custom status code to be sent to the client.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- recovery_
method str - Specifies the recovery method.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- custom
Status StringCode - Specifies the custom status code to be sent to the client.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- recovery
Method String - Specifies the recovery method.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorOriginFailureRecoveryPolicy
- Binary
Equivalent boolContent - Synchronizes content between the primary and backup origins, byte for byte.
- Enable
Ip boolAvoidance - Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the
configName
established fororiginResponsivenessRecoveryConfigName
is applied. - Enabled bool
- Activates and configures a recovery policy.
- Ip
Avoidance intError Threshold - Defines the number of failures that need to occur to an origin address before it's blocked.
- Ip
Avoidance intRetry Interval - Defines the number of seconds after which the IP address is removed from the blocklist.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Monitor
Origin boolResponsiveness - Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
- Monitor
Response List<string>Codes1s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - Monitor
Response List<string>Codes2s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - Monitor
Response List<string>Codes3s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here.. - Monitor
Status boolCodes1 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- Monitor
Status boolCodes1Enable Recovery - Enables the recovery action for the response codes you define.
- Monitor
Status boolCodes1Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- Monitor
Status stringCodes1Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - Monitor
Status boolCodes2 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- Monitor
Status boolCodes2Enable Recovery - Enables the recovery action for the response codes you define.
- Monitor
Status boolCodes2Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- Monitor
Status stringCodes2Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - Monitor
Status boolCodes3 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- Monitor
Status boolCodes3Enable Recovery - Enables the recovery action for the response codes you define.
- Monitor
Status boolCodes3Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- Monitor
Status stringCodes3Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - Origin
Responsiveness intCustom Timeout - Specify a custom timeout, from 1 to 10 seconds.
- Origin
Responsiveness boolEnable Recovery - Enables a recovery action for a specific failure condition.
- Origin
Responsiveness boolEnable Retry - If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
- Origin
Responsiveness stringMonitoring - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Origin
Responsiveness stringRecovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - Origin
Responsiveness stringTimeout - The timeout threshold that triggers a retry or recovery action.
- Status
Code stringMonitoring1 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Status
Code stringMonitoring2 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Status
Code stringMonitoring3 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Tuning
Parameters string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Binary
Equivalent boolContent - Synchronizes content between the primary and backup origins, byte for byte.
- Enable
Ip boolAvoidance - Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the
configName
established fororiginResponsivenessRecoveryConfigName
is applied. - Enabled bool
- Activates and configures a recovery policy.
- Ip
Avoidance intError Threshold - Defines the number of failures that need to occur to an origin address before it's blocked.
- Ip
Avoidance intRetry Interval - Defines the number of seconds after which the IP address is removed from the blocklist.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Monitor
Origin boolResponsiveness - Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
- Monitor
Response []stringCodes1s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - Monitor
Response []stringCodes2s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - Monitor
Response []stringCodes3s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here.. - Monitor
Status boolCodes1 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- Monitor
Status boolCodes1Enable Recovery - Enables the recovery action for the response codes you define.
- Monitor
Status boolCodes1Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- Monitor
Status stringCodes1Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - Monitor
Status boolCodes2 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- Monitor
Status boolCodes2Enable Recovery - Enables the recovery action for the response codes you define.
- Monitor
Status boolCodes2Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- Monitor
Status stringCodes2Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - Monitor
Status boolCodes3 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- Monitor
Status boolCodes3Enable Recovery - Enables the recovery action for the response codes you define.
- Monitor
Status boolCodes3Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- Monitor
Status stringCodes3Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - Origin
Responsiveness intCustom Timeout - Specify a custom timeout, from 1 to 10 seconds.
- Origin
Responsiveness boolEnable Recovery - Enables a recovery action for a specific failure condition.
- Origin
Responsiveness boolEnable Retry - If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
- Origin
Responsiveness stringMonitoring - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Origin
Responsiveness stringRecovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - Origin
Responsiveness stringTimeout - The timeout threshold that triggers a retry or recovery action.
- Status
Code stringMonitoring1 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Status
Code stringMonitoring2 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Status
Code stringMonitoring3 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Tuning
Parameters string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- binary
Equivalent BooleanContent - Synchronizes content between the primary and backup origins, byte for byte.
- enable
Ip BooleanAvoidance - Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the
configName
established fororiginResponsivenessRecoveryConfigName
is applied. - enabled Boolean
- Activates and configures a recovery policy.
- ip
Avoidance IntegerError Threshold - Defines the number of failures that need to occur to an origin address before it's blocked.
- ip
Avoidance IntegerRetry Interval - Defines the number of seconds after which the IP address is removed from the blocklist.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- monitor
Origin BooleanResponsiveness - Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
- monitor
Response List<String>Codes1s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - monitor
Response List<String>Codes2s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - monitor
Response List<String>Codes3s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here.. - monitor
Status BooleanCodes1 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status BooleanCodes1Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status BooleanCodes1Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status StringCodes1Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - monitor
Status BooleanCodes2 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status BooleanCodes2Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status BooleanCodes2Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status StringCodes2Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - monitor
Status BooleanCodes3 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status BooleanCodes3Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status BooleanCodes3Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status StringCodes3Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - origin
Responsiveness IntegerCustom Timeout - Specify a custom timeout, from 1 to 10 seconds.
- origin
Responsiveness BooleanEnable Recovery - Enables a recovery action for a specific failure condition.
- origin
Responsiveness BooleanEnable Retry - If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
- origin
Responsiveness StringMonitoring - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- origin
Responsiveness StringRecovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - origin
Responsiveness StringTimeout - The timeout threshold that triggers a retry or recovery action.
- status
Code StringMonitoring1 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- status
Code StringMonitoring2 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- status
Code StringMonitoring3 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- tuning
Parameters String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- binary
Equivalent booleanContent - Synchronizes content between the primary and backup origins, byte for byte.
- enable
Ip booleanAvoidance - Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the
configName
established fororiginResponsivenessRecoveryConfigName
is applied. - enabled boolean
- Activates and configures a recovery policy.
- ip
Avoidance numberError Threshold - Defines the number of failures that need to occur to an origin address before it's blocked.
- ip
Avoidance numberRetry Interval - Defines the number of seconds after which the IP address is removed from the blocklist.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- monitor
Origin booleanResponsiveness - Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
- monitor
Response string[]Codes1s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - monitor
Response string[]Codes2s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - monitor
Response string[]Codes3s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here.. - monitor
Status booleanCodes1 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status booleanCodes1Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status booleanCodes1Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status stringCodes1Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - monitor
Status booleanCodes2 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status booleanCodes2Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status booleanCodes2Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status stringCodes2Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - monitor
Status booleanCodes3 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status booleanCodes3Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status booleanCodes3Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status stringCodes3Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - origin
Responsiveness numberCustom Timeout - Specify a custom timeout, from 1 to 10 seconds.
- origin
Responsiveness booleanEnable Recovery - Enables a recovery action for a specific failure condition.
- origin
Responsiveness booleanEnable Retry - If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
- origin
Responsiveness stringMonitoring - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- origin
Responsiveness stringRecovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - origin
Responsiveness stringTimeout - The timeout threshold that triggers a retry or recovery action.
- status
Code stringMonitoring1 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- status
Code stringMonitoring2 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- status
Code stringMonitoring3 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- tuning
Parameters string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- binary_
equivalent_ boolcontent - Synchronizes content between the primary and backup origins, byte for byte.
- enable_
ip_ boolavoidance - Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the
configName
established fororiginResponsivenessRecoveryConfigName
is applied. - enabled bool
- Activates and configures a recovery policy.
- ip_
avoidance_ interror_ threshold - Defines the number of failures that need to occur to an origin address before it's blocked.
- ip_
avoidance_ intretry_ interval - Defines the number of seconds after which the IP address is removed from the blocklist.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- monitor_
origin_ boolresponsiveness - Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
- monitor_
response_ Sequence[str]codes1s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - monitor_
response_ Sequence[str]codes2s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - monitor_
response_ Sequence[str]codes3s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here.. - monitor_
status_ boolcodes1 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor_
status_ boolcodes1_ enable_ recovery - Enables the recovery action for the response codes you define.
- monitor_
status_ boolcodes1_ enable_ retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor_
status_ strcodes1_ recovery_ config_ name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - monitor_
status_ boolcodes2 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor_
status_ boolcodes2_ enable_ recovery - Enables the recovery action for the response codes you define.
- monitor_
status_ boolcodes2_ enable_ retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor_
status_ strcodes2_ recovery_ config_ name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - monitor_
status_ boolcodes3 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor_
status_ boolcodes3_ enable_ recovery - Enables the recovery action for the response codes you define.
- monitor_
status_ boolcodes3_ enable_ retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor_
status_ strcodes3_ recovery_ config_ name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - origin_
responsiveness_ intcustom_ timeout - Specify a custom timeout, from 1 to 10 seconds.
- origin_
responsiveness_ boolenable_ recovery - Enables a recovery action for a specific failure condition.
- origin_
responsiveness_ boolenable_ retry - If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
- origin_
responsiveness_ strmonitoring - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- origin_
responsiveness_ strrecovery_ config_ name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - origin_
responsiveness_ strtimeout - The timeout threshold that triggers a retry or recovery action.
- status_
code_ strmonitoring1 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- status_
code_ strmonitoring2 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- status_
code_ strmonitoring3 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- tuning_
parameters str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- binary
Equivalent BooleanContent - Synchronizes content between the primary and backup origins, byte for byte.
- enable
Ip BooleanAvoidance - Temporarily blocks an origin IP address that experienced a certain number of failures. When an IP address is blocked, the
configName
established fororiginResponsivenessRecoveryConfigName
is applied. - enabled Boolean
- Activates and configures a recovery policy.
- ip
Avoidance NumberError Threshold - Defines the number of failures that need to occur to an origin address before it's blocked.
- ip
Avoidance NumberRetry Interval - Defines the number of seconds after which the IP address is removed from the blocklist.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- monitor
Origin BooleanResponsiveness - Enables continuous monitoring of connectivity to the origin. If necessary, applies retry or recovery actions.
- monitor
Response List<String>Codes1s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - monitor
Response List<String>Codes2s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here. - monitor
Response List<String>Codes3s - Defines the origin response codes that trigger a subsequent retry or recovery action. Specify a single code entry (
501
) or a range (501:504
). If you configure othermonitorStatusCodes*
andmonitorResponseCodes*
options, you can't use the same codes here.. - monitor
Status BooleanCodes1 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status BooleanCodes1Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status BooleanCodes1Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status StringCodes1Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - monitor
Status BooleanCodes2 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status BooleanCodes2Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status BooleanCodes2Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status StringCodes2Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - monitor
Status BooleanCodes3 - Enables continuous monitoring for the specific origin status codes that trigger retry or recovery actions.
- monitor
Status BooleanCodes3Enable Recovery - Enables the recovery action for the response codes you define.
- monitor
Status BooleanCodes3Enable Retry - When the defined response codes apply, attempts a retry on the same origin before executing the recovery method.
- monitor
Status StringCodes3Recovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - origin
Responsiveness NumberCustom Timeout - Specify a custom timeout, from 1 to 10 seconds.
- origin
Responsiveness BooleanEnable Recovery - Enables a recovery action for a specific failure condition.
- origin
Responsiveness BooleanEnable Retry - If a specific failure condition applies, attempts a retry on the same origin before executing the recovery method.
- origin
Responsiveness StringMonitoring - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- origin
Responsiveness StringRecovery Config Name - Specifies a recovery configuration using the
configName
you defined in therecoveryConfig
match criteria. Specify 3 to 20 alphanumeric characters or dashes. Ensure that you use therecoveryConfig
match criteria to apply this option. - origin
Responsiveness StringTimeout - The timeout threshold that triggers a retry or recovery action.
- status
Code StringMonitoring1 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- status
Code StringMonitoring2 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- status
Code StringMonitoring3 - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- tuning
Parameters String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorOriginIpAcl
- Enable bool
- Enables the Origin IP Access Control List behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enable bool
- Enables the Origin IP Access Control List behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable Boolean
- Enables the Origin IP Access Control List behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable boolean
- Enables the Origin IP Access Control List behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable bool
- Enables the Origin IP Access Control List behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enable Boolean
- Enables the Origin IP Access Control List behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorOriginNetStorage
- Cp
Code int - Download
Domain stringName - G2o
Token string
- Cp
Code int - Download
Domain stringName - G2o
Token string
- cp
Code Integer - download
Domain StringName - g2o
Token String
- cp
Code number - download
Domain stringName - g2o
Token string
- cp_
code int - download_
domain_ strname - g2o_
token str
- cp
Code Number - download
Domain StringName - g2o
Token String
GetPropertyRulesBuilderRulesV20230105BehaviorPersistentClientConnection
- Enabled bool
- Enables the persistent connections behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Timeout string
- Specifies the timeout period after which edge server closes the persistent connection with the client, 500 seconds by default.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables the persistent connections behavior.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Timeout string
- Specifies the timeout period after which edge server closes the persistent connection with the client, 500 seconds by default.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the persistent connections behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- timeout String
- Specifies the timeout period after which edge server closes the persistent connection with the client, 500 seconds by default.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables the persistent connections behavior.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- timeout string
- Specifies the timeout period after which edge server closes the persistent connection with the client, 500 seconds by default.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables the persistent connections behavior.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- timeout str
- Specifies the timeout period after which edge server closes the persistent connection with the client, 500 seconds by default.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables the persistent connections behavior.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- timeout String
- Specifies the timeout period after which edge server closes the persistent connection with the client, 500 seconds by default.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorPersistentConnection
- Enabled bool
- Enables persistent connections.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Timeout string
- Specifies the timeout period after which edge server closes a persistent connection.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- Enables persistent connections.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Timeout string
- Specifies the timeout period after which edge server closes a persistent connection.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables persistent connections.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- timeout String
- Specifies the timeout period after which edge server closes a persistent connection.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- Enables persistent connections.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- timeout string
- Specifies the timeout period after which edge server closes a persistent connection.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- Enables persistent connections.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- timeout str
- Specifies the timeout period after which edge server closes a persistent connection.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- Enables persistent connections.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- timeout String
- Specifies the timeout period after which edge server closes a persistent connection.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorPersonallyIdentifiableInformation
- Enabled bool
- When enabled, marks content as personally identifiable information (PII).
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Enabled bool
- When enabled, marks content as personally identifiable information (PII).
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- When enabled, marks content as personally identifiable information (PII).
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled boolean
- When enabled, marks content as personally identifiable information (PII).
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled bool
- When enabled, marks content as personally identifiable information (PII).
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- enabled Boolean
- When enabled, marks content as personally identifiable information (PII).
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
GetPropertyRulesBuilderRulesV20230105BehaviorPhasedRelease
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Phased Release Cloudlet Policy - Specifies the Cloudlet policy as an object.
- Enabled bool
- Enables the Phased Release Cloudlet.
- Failover
Duration int - 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. - Failover
Enabled bool - Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
- Failover
Response List<string>Codes - Defines the set of failure codes that initiate the failover response.
- Failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Label string
- A label to distinguish this Phased Release policy from any others within the same property.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- Select when to assign a cookie to the population of users the Cloudlet defines. If you select the Cloudlet's
random
membership option, it overrides this option's value so that it is effectivelyNONE
. - Population
Duration string - Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
- Population
Expiration stringDate - 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.
- Population
Refresh bool - Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
- Population
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- Cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Phased Release Cloudlet Policy - Specifies the Cloudlet policy as an object.
- Enabled bool
- Enables the Phased Release Cloudlet.
- Failover
Duration int - 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. - Failover
Enabled bool - Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
- Failover
Response []stringCodes - Defines the set of failure codes that initiate the failover response.
- Failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Label string
- A label to distinguish this Phased Release policy from any others within the same property.
- Locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- Select when to assign a cookie to the population of users the Cloudlet defines. If you select the Cloudlet's
random
membership option, it overrides this option's value so that it is effectivelyNONE
. - Population
Duration string - Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
- Population
Expiration stringDate - 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.
- Population
Refresh bool - Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
- Population
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- Template
Uuid string - This option is for internal usage only.
- Uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Phased Release Cloudlet Policy - Specifies the Cloudlet policy as an object.
- enabled Boolean
- Enables the Phased Release Cloudlet.
- failover
Duration Integer - 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. - failover
Enabled Boolean - Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
- failover
Response List<String>Codes - Defines the set of failure codes that initiate the failover response.
- failover
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- label String
- A label to distinguish this Phased Release policy from any others within the same property.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- String
- Select when to assign a cookie to the population of users the Cloudlet defines. If you select the Cloudlet's
random
membership option, it overrides this option's value so that it is effectivelyNONE
. - population
Duration String - Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
- population
Expiration StringDate - 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.
- population
Refresh Boolean - Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
- population
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy GetProperty Rules Builder Rules V20230105Behavior Phased Release Cloudlet Policy - Specifies the Cloudlet policy as an object.
- enabled boolean
- Enables the Phased Release Cloudlet.
- failover
Duration number - 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. - failover
Enabled boolean - Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
- failover
Response string[]Codes - Defines the set of failure codes that initiate the failover response.
- failover
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- label string
- A label to distinguish this Phased Release policy from any others within the same property.
- locked boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- string
- Select when to assign a cookie to the population of users the Cloudlet defines. If you select the Cloudlet's
random
membership option, it overrides this option's value so that it is effectivelyNONE
. - population
Duration string - Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
- population
Expiration stringDate - 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.
- population
Refresh boolean - Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
- population
Title string - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid string - This option is for internal usage only.
- uuid string
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet_
policy GetProperty Rules Builder Rules V20230105Behavior Phased Release Cloudlet Policy - Specifies the Cloudlet policy as an object.
- enabled bool
- Enables the Phased Release Cloudlet.
- failover_
duration int - 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. - failover_
enabled bool - Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
- failover_
response_ Sequence[str]codes - Defines the set of failure codes that initiate the failover response.
- failover_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- label str
- A label to distinguish this Phased Release policy from any others within the same property.
- locked bool
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- str
- Select when to assign a cookie to the population of users the Cloudlet defines. If you select the Cloudlet's
random
membership option, it overrides this option's value so that it is effectivelyNONE
. - population_
duration str - Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
- population_
expiration_ strdate - 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.
- population_
refresh bool - Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
- population_
title str - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template_
uuid str - This option is for internal usage only.
- uuid str
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.
- cloudlet
Policy Property Map - Specifies the Cloudlet policy as an object.
- enabled Boolean
- Enables the Phased Release Cloudlet.
- failover
Duration Number - 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. - failover
Enabled Boolean - Allows failure responses at the origin defined by the Cloudlet to fail over to the prevailing origin defined by the property.
- failover
Response List<String>Codes - Defines the set of failure codes that initiate the failover response.
- failover
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- label String
- A label to distinguish this Phased Release policy from any others within the same property.
- locked Boolean
- Indicates that your Akamai representative has locked this behavior or criteria so that you can't modify it. This option is for internal usage only.
- String
- Select when to assign a cookie to the population of users the Cloudlet defines. If you select the Cloudlet's
random
membership option, it overrides this option's value so that it is effectivelyNONE
. - population
Duration String - Sets the lifetime of the cookie from the initial request. Subsequent requests re-evaluate based on current membership settings.
- population
Expiration StringDate - 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.
- population
Refresh Boolean - Enabling this option resets the original duration of the cookie if the browser refreshes before the cookie expires.
- population
Title String - This field is only intended for export compatibility purposes, and modifying it will not impact your use of the behavior.
- template
Uuid String - This option is for internal usage only.
- uuid String
- A uuid member indicates that at least one of its component behaviors or criteria is advanced and read-only. You need to preserve this uuid as well when modifying the rule tree. This option is for internal usage only.